Retrieve the specified incident.

get /v4/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.

CURL

  curl -X GET \

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

Path parameters

required

String

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

Example: id_example

Query parameters

expand

optional

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

optional

Boolean

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

Example: true

showEligibility

optional

Boolean

Example: true

Responses

Success

Body

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

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 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.