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

Genetec Mission Control™ Web API Release Notes 1.1

Applies to
Genetec Mission Control™ Web API 1.1
Last updated
2019-11-29
Content type
Release notes
Language
English
Product
Genetec Mission Control™
Version
2.11

With each release, new features, enhancements, or resolved issues are added to the product.

API versioning

Genetec Mission Control™ Web API 1.1 introduces API versioning. All endpoints now include a version identifier in the URL. To ensure backward compatibility, updated Web API endpoints will be introduced as a new version that must be targeted by applications.

This change breaks backward compatibility with applications developed for Genetec Mission Control™ Web API 1.0 GA. These applications must be updated to use the new versioned API syntax.

New API endpoints

The Web API uses endpoints to interact with Genetec Mission Control™.

The following endpoints are introduced in Genetec Mission Control™ Web API 1.1 :

GET /v1.1/Configuration/Priorities
Retrieve all incident priorities that are configured in Genetec Mission Control™.
GET /v1.1/Operation/Incidents/{id}/LinkedIncidentIds
Retrieve all incident identifiers that are linked to the specified incident.
GET /v1.1/Operation/Incidents/{id}/SourceIds
Retrieve all source identifiers that are related to the specified incident.

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

Third-party integration mode

A new user privilege has been added to Genetec Mission Control™ 2.11 for the Web API. Third-party integration mode allows the Web API to bypass some system validations and interact with incidents in an unrestricted way. It has the following effects:
  • Web API commands will bypass certain system requirements, such as:
    • Having incident ownership
    • Following the incident state flow
    • Being an incident recipient
    • Having the required privileges
  • Web API commands that bypass system requirements do not cause side effects, such as taking incident ownership.
  • The Web API user can query any active incident on a location they have access to.
  • The Web API user can trigger any In service incident type on a location they have access to.
  • The Web API user can receive notifications related to any active incident.
NOTE: Third-party integration mode only affects users interacting with the system through the Web API. Security Desk, Config Tool, and the legacy SDK are not impacted.

API enhancements

The enhancements for Genetec Mission Control™ Web API 1.1 are as follows:
Incident descriptions
Applications can now read and modify incident descriptions from the Web API. To make changes, the Web API user must have the Third-party integration mode privilege or the Change incident description privilege.

A notification has been added for incident descriptions. Applications can subscribe to be notified when an incident description has changed.

Incident priorities
Applications can now read and modify incident priorities from the Web API. To make changes, the Web API user must have the Third-party integration mode privilege or the Change incident priority privilege.

A notification has been added for incident priorities. Applications can subscribe to be notified when an incident priority has changed.

Incident comments
Applications can now add, modify, and delete incident comments from the Web API. To make changes, the Web API user must have the Third-party integration mode privilege or the Edit/delete incident comments privilege.

Three notifications have been added for incident comments. Applications can subscribe to be notified when an incident comment has been added, changed, or deleted.

Incident location
The Web API can now trigger an incident with or without a location. The location can be specified as an entity identifier, as geographical coordinates (latitude/longitude), or both.

The location of active incidents is returned by the GET /v1.1/Operation/Incidents and GET /v1.1/Operation/Incidents/{id} endpoints.

A notification has been added for incident location. Applications can subscribe to be notified when an incident location has changed.

Incident sources
Applications can now read the source or sources related to an active incident from the Web API.

All sources are returned by the GET /v1.1/Operation/Incidents and GET /v1.1/Operation/Incidents/{id} endpoints, in the SourceIds expandable field.

Linked incidents
Applications can now read and modify linked incidents from the Web API. To make changes, the Web API user must have the Third-party integration mode privilege or the Link incidents privilege.

Linked incidents are returned by the GET /v1.1/Operation/Incidents and GET /v1.1/Operation/Incidents/{id} endpoints, in the LinkedIncidentIds expandable field.

Two notifications have been added for linked incidents. Applications can subscribe to be notified when incidents have been linked or unlinked.