Skip to main content
PATCH
Update an incident

Authorizations

Authorization
string
header
required

OAuth2 Client Credentials Flow

Path Parameters

id
string
required

Body

application/json

Update an incident. Provide at least one field. status must be a valid transition from the current status.

changedByUserId
string
required

NetworkUser id of the acting Support Operator. Required on every write; attributes the change.

status
enum<string>

Lifecycle state. NEW, INVESTIGATING, MITIGATING, WAITING_ON_OEM, POST_MORTEM, RESOLVED, MERGED. RESOLVED and MERGED are terminal; MERGED is set only by a merge, never by a status update.

Available options:
NEW,
INVESTIGATING,
MITIGATING,
WAITING_ON_OEM,
POST_MORTEM,
RESOLVED,
MERGED
assigneeUserId
string | null

NetworkUser id to assign, or null to unassign.

summary
string
Maximum string length: 500
description
string
Maximum string length: 10000
rootCause
string
Maximum string length: 10000
resolutionNotes
string

Required when transitioning to RESOLVED (unless already set).

Maximum string length: 10000
reason
string

An optional note recorded on the status transition. Only valid with a status change.

Maximum string length: 10000
networkId
string

Network id. Required for machine (M2M) callers whose token carries no network claim; ignored when the token has one.

Response

The updated incident.

data
object

An incident: a period of degraded or lost service on one or more stations. The roster of affected stations lives on the affected-stations sub-resource; the incident carries only the cached affectedStationCount.