Incidents
Get an incident
Returns an incident by its identifier: what broke, what it falls on, which status it is in and whether it blocks the availability of the material.
incidents:readincidents:read- 120/min
- May need an add-on
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It does NOT include the repair cost or the internal resolution note.
Arguments
Incident identifier.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique incident identifier.
Human-readable incident number.
Short title of the incident.
Description; null if it has none.
Nature: damage, loss, malfunction, cosmetic, theft or custom.
What it affects: item, serializedItem, space, kit, vehicle or custom.
Available options: item, serializedItem, space, kit, vehicle, custom
Lifecycle status: draft, open, waiting, repairing, complete or lost.
Priority: urgent, high, medium, low or none.
Declared severity.
true when the incident removes the material from the available pool.
Affected units in bulk stock; null when not applicable.
Affected item; null if not applicable.
Affected physical unit; null if not applicable.
Affected space; null if not applicable.
Affected vehicle; null if not applicable.
Order in which it was detected; null if not applicable.
Associated project; null if not applicable.
Target resolution date in ISO 8601 UTC; null if it has none.
Comments the incident has.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/incidents/{incidentId}.
Related pages
Link to this section: Related pagesIncidents
Get an incident
Returns an incident by its identifier: what broke, what it falls on, which status it is in and whether it blocks the availability of the material.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?