Perform one command.

post /v2/Incidents

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

Request headers

prefer

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

Body parameters

TypeString (Enum)

Allowed values:"None""TriggerIncident""ChangeState""PlaceOnHold""ChangePriority""LinkIncidents""UnlinkIncidents""AddComment""ChangeComment""DeleteComment""ChangeDescription""ChangeExternalId""ChangeIncidentType""ChangeLocation""ClearLocation""TakeOwnership""ReleaseOwnership""AddNote""AnswerProcedureStep""TransferIncident""ForwardIncident""AttachEntities""DetachEntities""ChangeAdditionalFields"

REQUEST BODY

{
  "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"
    }
  ]
}

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: text/plain,application/json,text/json'
      
        -H
        'Content-Type: application/json'
      
          -H
          'prefer: prefer_example'
      
      'http://localhost/v2/Incidents'
    
      -d
      ''

Responses

The command was successfully processed.

Body

IdStringuuid

NameString

TypeIdStringuuid

TypeRevisionIntegerint32

DescriptionString

DisplayIdString

ExternalIdString

RecipientsModeInteger (Enum)int32

Allowed values:0123

RecipientIdsArray[string]

StateIdStringuuid

PendingStatesArray

[

TargetStateStringuuid

DelayObject

TicksIntegerint64

DaysIntegerint32

HoursIntegerint32

MillisecondsIntegerint32

MinutesIntegerint32

SecondsIntegerint32

TotalDaysNumberdouble

TotalHoursNumberdouble

TotalMillisecondsNumberdouble

TotalMinutesNumberdouble

TotalSecondsNumberdouble

]

DisabledStatesArray[string]

PriorityIdStringuuid

OwnerIdStringuuid

TriggerTimeUtcStringdate-time

LocationObject

EntityIdStringuuid

LatitudeNumberdouble

LongitudeNumberdouble

CurrentStepIdStringuuid

ProcedureIdStringuuid

ProcedureRevisionIntegerint32

IconIdStringuuid

ArgbColorString

ParentIdStringuuid

SoundIdStringuuid

IssuesString (Enum)

Allowed values:"None""ChatterDetected""WorkflowLoopDetected""DynamicSopLoopDetected"

TriggeredByIdStringuuid

TriggeredEventsArray

[

TypeString (Enum)

Represents incident event type that the api send to the client. Example: When we send an IncidentEventsNotification with SSE

Allowed values:"Uninitialized""StateChanged""RecipientsAltered""Created""PriorityChanged""Linked""Unlinked""CommentAdded""CommentChanged""CommentDeleted""LocationChanged""DescriptionChanged""ExternalIdChanged""IncidentTypeChanged""OwnershipChanged""LocationCleared""NoteAdded""ProcedureStepAnswered""ExternalEventAggregated""DisabledStatesChanged""EntitiesAttached""EntitiesDetached""AdditionalFieldChanged""DocumentAttached""DocumentDetached""KeepAlive"

ProcessTimeUtcStringdate-time

InstigatorIdStringuuid

]

LinkedIncidentIdsArray[string]

SourceIdsArray[string]

SubIncidentIdsArray[string]

ActiveCommentsArray

[

IdStringuuid

ValueString

CreatedByStringuuid

LastModifiedTimeStringdate-time

]

LocationAreaIdsArray[string]

AggregatedEventSourcesIdsArray[string]

ManuallyAttachedEntityIdsArray[string]

AdditionalFieldsArray

[

NameString

ValueString

DataTypeString (Enum)

Allowed values:"Boolean""Number""String""DateTime""Date""Url"

]

_linksObject

Additional propertiesString

EligibleRecipientsArray[string]

EligiblePartitionsArray[string]

RESPONSE

{
  "Id": "dc37ec6d-1ef7-4c46-8032-45fc0cdf068a",
  "Name": "Incident One",
  "TypeId": "c726ff6c-2c69-4f5a-b74a-33ef727877aa",
  "TypeRevision": 42,
  "Description": "Description One",
  "DisplayId": "1",
  "ExternalId": "",
  "RecipientsMode": 2,
  "RecipientIds": [
    "92aa9394-d1b8-4e05-8178-1f1a6c65cb3c",
    "99b94aa9-4590-4857-a1a5-1a0f2bebc52b",
    "f808e4fa-af0c-4119-bde6-53b30385e13b"
  ],
  "StateId": "775a9416-be54-4628-806e-80daf4dbae65",
  "PendingStates": [],
  "DisabledStates": [],
  "PriorityId": "ef76b1e3-ea07-4254-bbcc-e750b29a36cc",
  "OwnerId": "06f4d0b4-5961-4311-bbb4-49dfec9c66f1",
  "TriggerTimeUtc": "2023-08-15T21:10:09.3371064Z",
  "Location": {
    "EntityId": "d932669b-56ef-48f9-97ce-94ca11c3374f",
    "Latitude": 45.478759,
    "Longitude": -73.761054
  },
  "CurrentStepId": "3096e41b-3276-4376-acf2-6dcc556a923d",
  "ProcedureId": "c0ebee65-53f2-4106-bc99-bb83f9586a03",
  "ProcedureRevision": 1234,
  "IconId": "f74f6757-f25b-46a9-a916-48d7c1bd43ef",
  "ArgbColor": "#AABBCCDD",
  "ParentId": "285245a9-5d9a-4d77-be34-178bd2ec4631",
  "SoundId": "23eb9c8f-61a1-41cb-b99e-20598a75f772",
  "Issues": "None",
  "TriggeredEvents": [],
  "LinkedIncidentIds": [],
  "SourceIds": [],
  "SubIncidentIds": [],
  "ActiveComments": [],
  "LocationAreaIds": [],
  "AggregatedEventSourcesIds": [],
  "ManuallyAttachedEntityIds": [],
  "AdditionalFields": [],
  "_links": {
    "Events": "/Incidents/dc37ec6d-1ef7-4c46-8032-45fc0cdf068a/Events"
  }
}

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.