Operations

Incident

Broken, lost or malfunctioning material, with its repair status.

Schemas: IncidentDto

{
  "id": "id_8f2a1c",
  "identifier": "string",
  "title": "Example",
  "description": "string",
  "type": "string",
  "scope": "item",
  "status": "string",
  "priority": "string",
  "severity": "string",
  "blocksAvailability": true,
  "affectedQuantity": 1,
  "itemId": "string",
  "serializedItemId": "string",
  "spaceId": "string",
  "vehicleId": "string",
  "orderId": "string",
  "projectId": "string",
  "dueDate": "2026-09-01T08:00:00Z",
  "commentCount": 1,
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

Broken, lost or malfunctioning material, with its repair status. An incident points to the item, serialized item, space, vehicle, order or project it affects, and blocksAvailability says whether it takes stock out of availability. It needs the incidence add-on: without it the answer is 402, not 403. The cost of the repair and the internal resolution note are not published.

Attributes

idstring

Unique incident identifier.

identifierstring

Human-readable incident number.

titlestring

Short title of the incident.

descriptionstring | null

Description; null if it has none.

typestring

Nature: damage, loss, malfunction, cosmetic, theft or custom.

scopestring

What it affects: item, serializedItem, space, kit, vehicle or custom.

Available options: item, serializedItem, space, kit, vehicle, custom

statusstring

Lifecycle status: draft, open, waiting, repairing, complete or lost.

prioritystring

Priority: urgent, high, medium, low or none.

severitystring

Declared severity.

blocksAvailabilityboolean

true when the incident removes the material from the available pool.

affectedQuantityinteger | null

Affected units in bulk stock; null when not applicable.

itemIdstring | null

Affected item; null if not applicable.

serializedItemIdstring | null

Affected physical unit; null if not applicable.

spaceIdstring | null

Affected space; null if not applicable.

vehicleIdstring | null

Affected vehicle; null if not applicable.

orderIdstring | null

Order in which it was detected; null if not applicable.

projectIdstring | null

Associated project; null if not applicable.

dueDatestring<date-time> | null

Target resolution date in ISO 8601 UTC; null if it has none.

commentCountinteger

Comments the incident has.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

Values

scope: item, serializedItem, space, kit, vehicle, custom

Returned by

GET /api/v1/incidents — List incidents
GET /api/v1/incidents/{incidentId} — Get an incident

Modified by

POST /api/v1/incidents — Open an incident
PATCH /api/v1/incidents/{incidentId} — Update an incident
POST /api/v1/incidents/{incidentId}/comments — Comment on an incident

Was this page helpful?