Incidents
Update an incident
Updates an incident (send only the fields to change).
incidents:writeincidents:write- 120/min
- May need an add-on
- Server annotation: Idempotent
Result
generated from the schema
Lists fully replace the existing one. Costs, the internal resolution note and publication on the customer portal cannot be written here. Returns the updated incident.
Arguments
Incident identifier.
Limits: min length 1
Short title.
Limits: min length 1
Nature of the incident.
Available options: damage, loss, malfunction, cosmetic, theft, custom
What it affects.
Available options: item, serializedItem, space, kit, vehicle, custom
Lifecycle status.
Available options: draft, open, waiting, repairing, complete, lost
Priority.
Available options: urgent, high, medium, low, none
Severity.
Available options: low, high
Whether the team repairs it or an external workshop does.
Available options: internal, external
Description.
Whether it removes the material from the pool.
Affected units.
Limits: max 10000, > 0
Affected item; null unlinks it.
Physical unit; null unlinks it.
Variant; null unlinks it.
Space; null unlinks it.
Vehicle; null unlinks it.
Order; null unlinks it.
Project; null unlinks it.
Involved contacts. Replaces the list.
Assigned staff. Replaces the list.
Deprecated: accepted for compatibility and ignored. Incidents no longer keep a subscriber list.
Labels. Replaces the list.
Photos of the damage. Replaces the list.
Incidents that block this one.
Target date, in ISO 8601 with offset; null clears it.
Estimated resolution date, in ISO 8601 with offset; null clears it.
Actual resolution date, in ISO 8601 with offset; null clears it.
Enables the internal reminder.
Reminder date, in ISO 8601 with offset; null clears it.
Parent incident; null unlinks it.
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
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 PATCH /api/v1/incidents/{incidentId}.
Related pages
Link to this section: Related pagesIncidents
Update an incident
Updates an incident (send only the fields to change).
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?