Versions Compared

Old Version 2

changes.mady.by.user Vadim Belyakov

Saved on

compared with

New Version Current

changes.mady.by.user Vadim Belyakov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleNote

The ENDTIME and BEGINTIME syntax is described in Get archive contents section.


Note
titleAttention!

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.

...

Tip

{VIDEOSOURCEID} - three-component source endpoint ID (see Get list of video sources (cameras)cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

...

ParameterRequiredDescription
limitNo

The limit of alarms in the response. If not specified, it is equal to 100 by default.

offsetNo

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_archiveNo

Is available starting with Axxon Next 4.4.1.9150.

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 older footage).

archiveNo

Is available starting with Axxon Next 4.4.1.9150.

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

...

ParameterDescription
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:

  1. Name of the user initiated the alarm.
  2. Id of the macro (see Using macros) if the alarm is initiated by macro that was started NOT by the detector (even if this macro has already been removed from the configuration).
  3. Type of detector that triggered macro that initiated the alarm (see Get list of detection tools events).

...