Genetec Mission Control™ Web API 2.0 includes the following enhancements.
Web API 2.0 now available
- In the Web API documentation, there is a drop-down list allowing selection between documentation for the legacy version V1 and new version V2. By default, the documentation for the V2 version is displayed.
- Re-categorization of endpoints.
- A standardized format for all endpoints returning a collection of results:
- Quantitative filters are available that allow you to set the offset and number of items to be retrieved.
- The retrieved results include a count for the total number of items available for the query, and the list of items retrieved within the set limit parameter.
- Change in default filter behavior. When no filters are specified by the user, all expected possible items will be retrieved.
- A new isRecipient filter is available for the
GET /v2/Incidents
andGET /v2/Incidents/{id}
endpoints that allows the user to retrieve for which the user is either a recipient or a supervisor. - The
GET /v2/IncidentTypes
endpoints will now also return incidents that are not configured for manual trigger. The retrieved incident type properties include details of the manual trigger configuration. - All incident commands are now posted synchronously by default ( ).
You must have Genetec Mission Control™ 2.13.4.0 installed for compatibility with Web API 2.0.
To upgrade to the latest version of Web API, you must uninstall the previous version of the Genetec Mission Control™ Web API Installer.
API enhancements
- Retrieve dynamic user procedure details
- You can use the
GET /v2/Procedures/{id}
endpoint to retrieve the dynamic user procedure associated with the specified identifier.It includes the following fields:- Step name
- Instruction text
- Step options
- Allow skip configuration
- Force comment configuration
To retrieve a specific revision of the dynamic user procedure, use the
GET /v2/Procedures/{id}/Revisions/{revision}
endpoint. - Retrieve incident type revision
- You can use the
GET /v2/IncidentTypes/{id}/Revisions/{revision}
endpoint to retrieve a specific revision of the specified incident type. - Retrieve aggregated custom events
- You can retrieve events history for aggregated external custom events
using the
GET /v2/Incidents/{id}/Events
with the ExternalEventAggregated eventTypes parameter.The number of events retrieved will depend on limit filter selection.
- Retrieve a list of possible incident states
- You can use the
GET /v2/States
endpoint to retrieve a list of possible incident states.
For technical information about these API endpoints and other programming considerations, see the Web API developer documentation.