Retrieve history of events associated with the specified incident.

Genetec Mission Control™ Web API

Content type
OpenAPI specifications
Product line
Mission Control
Language
English
Applies to
Genetec Mission Control™ Web API
get /v4/Incidents/{id}/Events

  • The incident is not closed.
  • The authenticated Security Center user has incident management privileges.

With _Third-party integration mode_ or _Incident report_ privileges, you can retrieve incident events history irrespective of incident state.

Current limitation: the total results count value will always be null.

Returns the history of events associated with the incident specified by identifier under the following conditions:

CURL
curl -X GET \ -H "Accept: application/json" \ "http://localhost/v4/Incidents/{id}/Events?dateTimeFrom=2013-10-20T19:20:30+01:00&dateTimeTo=2013-10-20T19:20:30+01:00&eventTypes=&offset=56&limit=56"
Path parameters
id
required
String
Guid/Uuid of the required incident. Example: ADBD25C1-127C-4D05-898D-CCF82D8DB59F
Example: id_example
Query parameters
dateTimeFrom
optional
Object format: date-time
This query parameter allows you to retrieve events that were generated after the provided date.
You can specify date in either of the following formats:
  • Local date and time format: yyyy-mm-dd hh:mm:ss
  • UTC format: yyyy-mm-ddThh:mm:ssZ
format: date-time
Example: 2013-10-20T19:20:30+01:00
dateTimeTo
optional
Object format: date-time
This query parameter allows you to retrieve events that were generated before the provided date.
You can specify date in either of the following formats:
  • Local date and time format: yyyy-mm-dd hh:mm:ss
  • UTC format: yyyy-mm-ddThh:mm:ssZ
format: date-time
Example: 2013-10-20T19:20:30+01:00
eventTypes
optional
Array of integers format: int32
This query parameter allows you to retrieve events that match the specified event type identifier.
You can provide multiple identifiers separated by commas. format: int32
offset
optional
Object format: int32
This query parameter allows you to set the number of items to be skipped.
The default value for this parameter is 0. format: int32
Example: 56
limit
optional
Object format: int32
This query parameter allows you to set the number of items to retrieve. Maximum value: 100.
The default value for this parameter is 25. format: int32
Example: 56
Responses

Success

Body
TotalResultsCount
optional
Integer
format: int32
Results
optional
Array of objects

The Web API was unable to process the request due to a client error (malformed request syntax, size too large, invalid request message framing, or deceptive request routing).

The token you submitted was either invalid or expired.

The token you submitted was valid, but either did not grant sufficient privilege to access the requested resource, or the Web API license is not active.

The requested resource could not be found.

The request could not be completed. Genetec Mission Control™ licenses exceeded.

The Web API was unable to process the request.

The Web API received an invalid response from the Incident Manager role.

The Web API did not receive a response to the request. The Incident Manager role might be down at the moment.