Incidents
Open an incident
Records broken, lost or damaged material.
incidents:writeincidents:write- 120/min
- May need an add-on
Result
generated from the schema
With blocksAvailability: true the material leaves the available pool while the incident remains open; if the item is tracked by quantity and you do not indicate a specific physical unit, affectedQuantity becomes required. The repair cost is NOT part of the public contract. Returns the created incident.
Arguments
Short title, the one shown in lists and cards.
Limits: min length 1
Nature of the incident.
Available options: damage, loss, malfunction, cosmetic, theft, custom
What the incident affects.
Available options: item, serializedItem, space, kit, vehicle, custom
Initial status. Defaults to "draft".
Available options: draft, open, waiting, repairing, complete, lost
Priority. Defaults to "none".
Available options: urgent, high, medium, low, none
Severity. Defaults to "low".
Available options: low, high
Description of what happened.
true removes the material from the available pool while the incident is open.
Affected units. Required when blocking bulk stock.
Limits: max 10000, > 0
Affected item.
Specific physical unit affected.
Affected item variant.
Affected space.
Affected vehicle.
Order in which it was detected.
Associated project.
Involved contacts (supplier, insurer, client) so they can see it.
Staff assigned to resolve it.
Deprecated: accepted for compatibility and ignored. Incidents no longer keep a subscriber list.
Free-form labels of the incident.
URLs of photos of the damage.
Target resolution date, in ISO 8601 with offset.
Enables the internal reminder.
Reminder date, in ISO 8601 with offset.
Incident of which this one is a child.
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.
Sample prompts
Open an incident: the matte box of this camera came back with a cracked filter holder.
The same operation by REST
This tool runs POST /api/v1/incidents.
Related pages
Link to this section: Related pagesIncidents
Open an incident
Records broken, lost or damaged 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?