What's new in Genetec Mission Control™ Web API 1.5 - Genetec Mission Control™ Web API 1.5

Genetec Mission Control™ Web API Release Notes 1.5

series
Genetec Mission Control™ Web API 1.5
revised_modified
2020-07-16

Genetec Mission Control™ Web API 1.5 includes the following enhancements.

API enhancements

You can use Genetec Mission Control™ Web API 1.5 for the following:
Add notes to incident activity report
You can use the POST /V1/Operation/Incidents/{Id} endpoint to add a note to an incident's latest activity log.
It includes the following fields:
NoteType
The note origin external system identifier
DisplayText
Note text with a maximum of 500 characters. It can be empty if the Payload string is not empty.
Payload
Specific data about the note from external system of note origin. Payload strings can have a maximum of 10,000 characters and can be an empty string only when DisplayText is not empty.
PayloadFormat
Payload can be in JSON, XML, or other formats such as Binary and so on.
Retrieve user comments for an active incident
You can use the GET /V1/Operation/Incidents/{Id}/ActiveComments endpoint to retrieve the latest version of all active user comments in an incident's latest activity log.
The retrieved comments are listed in reverse chronological order and include the following details:
  • Comment identifier
  • Comment value
  • Security Center user ID identifying the user who created the comment
  • Time stamp indicating the last time the comment was modified
NOTE: The comments retrieved do not include deleted comments.
Retrieve incident event history
You can use the GET /V1/Operation/Incidents/{Id}/Events endpoint to retrieve the history of events associated with the specified incident under the following conditions:
  • The incident is not Closed.
  • The authenticated Security Center user has incident management privileges.
NOTE: With Third party integration mode or Incident report privileges, you can retrieve incident events history irrespective of incident state.
You can customize the report query using the following filters:
offset
This query parameter allows you to retrieve a sub-set of events by setting the number of events to be skipped.

If no value is provided, the default value is set to 0.

limit
This query parameter allows you to set the maximum number of events to retrieve. You can retrieve up to 100 events.

If no value is provided, the default value is set to 25.

dateTimeFrom
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
dateTimeTo
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
eventTypes
This query parameter allows you to retrieve events that match the specified event type identifier.

You can provide multiple identifiers separated by commas.

Use synchronous mode on incident commands
You can use the Prefer HTTP header with the Prefer sync option on commands to minimize dependency on SignalR.

If the Prefer sync option takes more than 5 seconds, or if the Prefer HTTP header is not present, the Web API will fall back to the default Prefer async mode and return a HTTP 202 with MessageID and CorrelationID.

Most commands will return an updated JSON file in the HTTP response. The LinkIncidents and UnlinkIncidents commands will return a HTTP 204 when the commands are executed and the selected action is complete.

Retrieve reports on active and closed incidents
You can query reports on incidents using any of the following options if you have the Incident report privilege or the Third party integration mode privilege:
Without using any filters
Use GET /V1/Operation/Incidents to retrieve a list of active incidents based on privileges assigned to an authenticated Security Center user. With the Third party integration mode or Incident report privilege you can retrieve a list of closed incidents.
Options and filters for your incident reports
You can set one or more of the following filters when retrieving your incident report details:
limit
You can set the limit on the maximum number of incidents to be retrieved.
offset
You can use this filter when you need to retrieve a subset of incidents.
dateTimeFrom
You can use this filter to only retrieve incidents triggered after the specified date.
dateTimeTo
You can use this filter to only retrieve incidents triggered before the specified date.
incidentTypeIds
You can use this filter to retrieve incident that match one or more incident types.
priorityIds
You can use this filter to retrieve incidents that currently have any of the listed incident priorities.
stateIds
You can use this filter to retrieve incidents that are currently in the specified state.
Retrieve icons
You can use the GET /V1/Resources/Icon/{Id} to retrieve the icon associated with the specified icon identifier. The icon identifier, and the Argb color can be retrieved in the incident JSON.

For technical information about these API endpoints and other programming considerations, see the Web API developer documentation.