Perform one command.

Genetec Mission Control™ Web API

Content type
OpenAPI specifications
Product line
Mission Control
Language
English
Applies to
Genetec Mission Control™ Web API
post /v4/Incidents

Issues one command to the system from the body of the POST.

CURL
curl -X POST \ -H "Accept: text/plain,application/json,text/json" \ -H "Content-Type: application/json" -H "prefer: prefer_example" \ "http://localhost/v4/Incidents" \ -d '{ }'
Request headers
prefer
optional
String
Specify "sync" or "async" to have the server process the request synchronously or asynchronously. If the parameter is omitted, the server will process the request asynchronously.
Example: prefer_example
Request
Body
optional

A JSON object containing one command (multiple commands in a single POST are not supported). The following commands can be sent through this endpoint:

  • LinkIncidents
  • TriggerIncident
  • UnlinkIncidents
Example: {"Type":"TriggerIncident","IncidentTypeId":"e1d88b39-ad18-45b7-943c-acfb6d5bc14e","Location":{"EntityId":"c4b99eb6-3eba-4077-8c16-1d7ed3e8c86c","Latitude":45.478759,"Longitude":-73.761054},"ExternalId":"","Comment":"","AdditionalFields":[{"Name":"Payload1","Value":"true"},{"Name":"Payload2","Value":"1"}]}
Type
optional
Object
Responses

The command was successfully processed.

Body
Id
optional
String (UUID)
format: uuid
Name
optional
String
TypeId
optional
String (UUID)
format: uuid
TypeRevision
optional
Integer
format: int32
Description
optional
String
DisplayId
optional
String
ExternalId
optional
String
RecipientsMode
optional
Object
RecipientIds
optional
Array of strings (UUID)
format: uuid
StateId
optional
String (UUID)
format: uuid
PendingStates
optional
Array
TargetState
optional
String (UUID)
format: uuid
Delay
optional
Ticks
optional
Number (Long)
format: int64
Days
optional
Integer
format: int32
Hours
optional
Integer
format: int32
Milliseconds
optional
Integer
format: int32
Minutes
optional
Integer
format: int32
Seconds
optional
Integer
format: int32
TotalDays
optional
Number (Double)
format: double
TotalHours
optional
Number (Double)
format: double
TotalMilliseconds
optional
Number (Double)
format: double
TotalMinutes
optional
Number (Double)
format: double
TotalSeconds
optional
Number (Double)
format: double
DisabledStates
optional
Array of strings (UUID)
format: uuid
PriorityId
optional
String (UUID)
format: uuid
OwnerId
optional
String (UUID)
format: uuid
TriggerTimeUtc
optional
Object
format: date-time
Location
optional
EntityId
optional
String (UUID)
format: uuid
Latitude
optional
Number (Double)
format: double
Longitude
optional
Number (Double)
format: double
CurrentStepId
optional
String (UUID)
format: uuid
ProcedureId
optional
String (UUID)
format: uuid
ProcedureRevision
optional
Integer
format: int32
IconId
optional
String (UUID)
format: uuid
ArgbColor
optional
String
ParentId
optional
String (UUID)
format: uuid
SoundId
optional
String (UUID)
format: uuid
Issues
optional
Object
TriggeredById
optional
String (UUID)
format: uuid
TriggeredEvents
optional
Array
Type
optional
Object
Represents incident event type that the api send to the client. Example: When we send an IncidentEventsNotification with SSE
ProcessTimeUtc
optional
Object
format: date-time
InstigatorId
optional
String (UUID)
format: uuid
LinkedIncidentIds
optional
Array of strings (UUID)
format: uuid
SourceIds
optional
Array of strings (UUID)
format: uuid
SubIncidentIds
optional
Array of strings (UUID)
format: uuid
ActiveComments
optional
Array
Id
optional
String (UUID)
format: uuid
Value
optional
String
CreatedBy
optional
String (UUID)
format: uuid
LastModifiedTime
optional
Object
format: date-time
LocationAreaIds
optional
Array of strings (UUID)
format: uuid
AggregatedEventSourcesIds
optional
Array of strings (UUID)
format: uuid
ManuallyAttachedEntityIds
optional
Array of strings (UUID)
format: uuid
AdditionalFields
optional
Array
Name
optional
String
Value
optional
String
DataType
optional
Object
_links
optional
Map of strings
EligibleRecipients
optional
Array of strings (UUID)
format: uuid
EligiblePartitions
optional
Array of strings (UUID)
format: uuid

The command was successfully processed and resulted in a new resource being created.

The command was successfully received and will be processed. Subscribe to the notification feed (/notifications) to receive events related to the command. Events will be sent to subscribers when the command has been successfully processed, otherwise no events will be sent.

The command was successfully processed, but no content needs to be returned.

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 submitted was either invalid or expired.

The command was not processed because of insufficient privilege.

The command was not processed as one or more of the specified incident IDs were invalid.

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

The Web API was unable to process the command.

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