Sign in
Incidents

Update Incident

Update incident. Title is the only mutable field.

put/v1/incidents/{incident-id}

Path parameters

incident-idinteger required

Request body

titlestring required

New incident title (cannot be empty, truncated to 255 characters).

Response

Incident updated.

idinteger

Unique incident identifier.

stateinteger

Incident state: 0 open, 1 in progress, 2 blocked, 3 resolved, 4 closed.

stateNamestring

Human-readable incident state name.

titlestring

Incident title (up to 255 characters).

sourceObjectIdinteger

ID of object the incident was created on.

sourceObjectNamestring

Name of the source object.

assignedUserIdinteger

ID of user the incident is assigned to, or 0 when unassigned.

assignedUserNamestring

Login name of assigned user. Unassigned incidents must be detected by testing assignedUserId for 0, not by matching on this name - user ID 0 resolves to the built-in "system" account.

alarmCountinteger

Number of alarms linked to the incident.

creationTimestring date-time

Incident creation time.

lastChangeTimestring date-time

Time of last incident change.

sourceAlarmIdinteger

ID of alarm the incident was created from, or 0 if created manually.

createdByUserinteger

ID of user who created the incident, or 0 when created by event processing rule.

createdByUserNamestring

Login name of creating user. Resolves to the built-in "system" account when the incident was created by an event processing rule.

resolvedByUserinteger

ID of user who resolved the incident, or 0 if not resolved yet.

resolvedByUserNamestring

Login name of resolving user. Meaningful only when resolvedByUser is not 0.

resolveTimestring date-time nullable

Time the incident was resolved, or null if not resolved yet.

closedByUserinteger

ID of user who closed the incident, or 0 if not closed yet.

closedByUserNamestring

Login name of closing user. Meaningful only when closedByUser is not 0.

closeTimestring date-time nullable

Time the incident was closed, or null if not closed yet.

linkedAlarmsinteger[]

IDs of alarms linked to the incident.

Changes

Changed in 1 of the 85 revisions of this API.1