Comment text. Line breaks are allowed.
Limits: min length 1
Incidents
Records progress on the incident: the workshop confirming receipt, the quote arriving.
incidents:writeincidents:writegenerated from the schema
It does not accept attachments because v1 has no file upload. Returns the full incident, with its commentCount updated, the same projection as its GET.
Incident identifier.
Limits: min length 1
Comment text. Line breaks are allowed.
Limits: min length 1
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
On success the result carries structuredContent with data and meta. These are 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.
This tool runs POST /api/v1/incidents/{incidentId}/comments.
Incidents
Records progress on the incident: the workshop confirming receipt, the quote arriving.
Guides
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
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.
Was this page helpful?