Retrieve the specified incident.

get /v2/Incidents/{id}

Returns an active incident with matching identifier, if it was sent to the authenticated Security Center user as a recipient or a supervisor. If this user has the Third-party integration mode privilege or the Incident Report privilege, returns any incident with matching identifier regardless of its status.

Path parameters

String

required

Guid/Uuid of the required incident. _Example:_ `ADBD25C1-127C-4D05-898D-CCF82D8DB59F`

Example: id_example

Query parameters

expand

String

This query parameter allows you to retrieve sub-resources immediately instead of retrieving them in a separate request. It is possible to expand multiple properties by delimiting them with commas, or specifying "all" to expand all sub-resources. For the list of expandable sub-resources, please consult the **Incident** model in the **Models** section.

Example: expand_example

isRecipient

Boolean

This query parameter will enforce a validation to see if you are a recipient or supervisor of the incident.

Example: true

showEligibility

Boolean

Example: true

CLIENT REQUEST

          curl -X 'GET'

        -H
        'Accept: application/json'
      
      'http://localhost/v2/Incidents/{id}?expand=expand_example&isRecipient=true&showEligibility=true'

Responses

Success

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": "f9afdb0b-8e04-4bc2-b2a1-997369c8b13a",
  "Name": "Incident One",
  "TypeId": "f4dfd7fa-daa9-498d-bdf9-539f3ab5cda4",
  "TypeRevision": 42,
  "Description": "Description One",
  "DisplayId": "1",
  "ExternalId": "",
  "RecipientsMode": 2,
  "RecipientIds": [
    "b808d36f-c2eb-4758-b967-a7d81fdeaa39",
    "60079903-e3ba-4ce9-94f9-b48adfb02017",
    "ac6fff56-8213-48b9-ada7-7d40b60fe8c1"
  ],
  "StateId": "775a9416-be54-4628-806e-80daf4dbae65",
  "PendingStates": [],
  "DisabledStates": [],
  "PriorityId": "ef76b1e3-ea07-4254-bbcc-e750b29a36cc",
  "OwnerId": "5e3ea628-72eb-491c-8446-46195255bbd8",
  "TriggerTimeUtc": "2023-08-15T21:10:09.4025216Z",
  "Location": {
    "EntityId": "ced589f8-e478-4b0b-a511-5fc67d8addf6",
    "Latitude": 45.478759,
    "Longitude": -73.761054
  },
  "CurrentStepId": "5db9d462-fb67-4f6c-aa79-9353a65897fc",
  "ProcedureId": "5007c818-13e5-48cf-a1ce-56b161936676",
  "ProcedureRevision": 1234,
  "IconId": "650baf60-2ced-450b-8e29-18c4a26ae488",
  "ArgbColor": "#AABBCCDD",
  "ParentId": "7383afeb-7072-49ca-b050-92fcc727baf7",
  "SoundId": "83d3d010-1790-4f17-ab18-478d26d1d79e",
  "Issues": "None",
  "_links": {
    "Events": "/Incidents/f9afdb0b-8e04-4bc2-b2a1-997369c8b13a/Events",
    "PossibleStateTransitions": "/Incidents/f9afdb0b-8e04-4bc2-b2a1-997369c8b13a/PossibleStateTransitions"
  }
}

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

The token you submitted was valid, but either did not grant sufficient privilege to access the requested resource, or the Web API license is not active.

The requested resource could not be found.

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

The Web API was unable to process the request.

The Web API received an invalid response from the Incident Manager role.

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