Documentation for C-Werk 2.0.
Previous page
Next page
GET http://IP-Address:port/prefix/archive/events/alerts/{ENDTIME}/{BEGINTIME} − get alarms from all Domain Servers.
Note
The ENDTIME and BEGINTIME syntax is described in Get archive contents section.
Attention!
If ENDTIME < BEGINTIME in the request, then the events in the response will be sorted by time in ascending order.
If ENDTIME > BEGINTIME, then the events will be sorted in descending order.
GET http://IP-Address:port/prefix/archive/events/alerts/{HOSTNAME}/{ENDTIME}/{BEGINTIME} − get alarms from a certain Server.
{HOSTNAME} − Server name (see Get Server list).
GET http://IP-Address:port/prefix/archive/events/alerts/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME} − get alarms from a certain camera.
{VIDEOSOURCEID} − three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".
| Parameter | Required | Description |
|---|---|---|
| limit | No | The limit of alarms in the response. If not specified, it is equal to 100 by default. |
| offset | No | The results offset by the specified number. For example, if a query with offset=0 returned 100 results, then in order to get the next results, it is necessary to run a query with offset=100. If the second query returned 250 results, then in order to get the next results, it is necessary to run a query with offset=350, etc. |
| limit_to_archive | No | If limit_to_archive=1, then the response will return the events only from the accessible part of the archive (see Configuring access restrictions to archive). |
| archive | No | The name of the archive from the request to receive the list of archives (see Get archive contents). |
Sample request:
GET http://127.0.0.1:80/archive/events/alerts/Server1/past/future?limit=50&offset=0
Sample response:
{
"events": [
{
"type": "alert",
"id": "2bb7f765-eb57-604d-a38c-d1d26d22e4d9",
"raisedAt": "20181219T151437.312808",
"zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
"reasons": [
"ruleAlert",
"videoDetector"
],
"initiator": "faceAppeared",
"reaction": {
"user": "",
"reactedAt": "20181219T151937.342036",
"severity": "unclassified"
},
"detectorName": "1.Face detection",
"rectangles": [
{
"index": "47",
"left": "0,85343749999999996",
"top": "0,37958333333333333",
"right": "1",
"bottom": "0,58083333333333331"
}
]
},
{
"type": "alert",
"id": "03c0d49f-5475-684e-a622-2aaeac303508",
"raisedAt": "20181219T151005.933417",
"zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
"reasons": [
"ruleAlert",
"videoDetector"
],
"initiator": "faceAppeared",
"reaction": {
"user": "root",
"reactedAt": "20181219T151013.109256",
"severity": "alarm"
},
"detectorName": "1.Face detection",
"rectangles": [
{
"index": "9",
"left": "0,83406249999999993",
"top": "0,36416666666666664",
"right": "1",
"bottom": "0,58583333333333332"
}
]
},
{
"type": "alert",
"id": "6d396f93-4acf-c54b-a26e-c1ab178bdb06",
"raisedAt": "20181219T150911.101417",
"zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
"reasons": [
"userAlert"
],
"initiator": "root",
"reaction": {
"user": "root",
"reactedAt": "20181219T150916.264631",
"severity": "alarm"
},
"detectorName": "",
"rectangles": []
}
],
"more": false
}
| Parameter | Description |
|---|---|
| raisedAt | Field raisedAt is not unique so it might be necessary to skip the previously received alarms starting from the search interval. |
| reasons | Possible values of the reasons array: armed, disarmed, userAlert, ruleAlert, videoDetector, audioDetector, ray. |
| severity | Possible values of the severity field: unclassified, false, notice, warning, alarm. |
| initiator | Possible values of the initiator field:
|
Overview
Content Tools