Incidents

Update an incident

Updates an incident (send only the fields to change).

Tool
filmo_incidents_update
Access: Write

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_incidents_update",
    "arguments": {
      "incidentId": "inci_8f2a1c"
    }
  }
}

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

incidentIdstringRequired

Incident identifier.

Limits: min length 1

titlestring

Short title.

Limits: min length 1

typestring

Nature of the incident.

Available options: damage, loss, malfunction, cosmetic, theft, custom

scopestring

What it affects.

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

statusstring

Lifecycle status.

Available options: draft, open, waiting, repairing, complete, lost

prioritystring

Priority.

Available options: urgent, high, medium, low, none

severitystring

Severity.

Available options: low, high

repairTypestring | null

Whether the team repairs it or an external workshop does.

Available options: internal, external

descriptionstring | null

Description.

blocksAvailabilityboolean

Whether it removes the material from the pool.

affectedQuantityinteger | null

Affected units.

Limits: max 10000, > 0

itemIdstring | null

Affected item; null unlinks it.

serializedItemIdstring | null

Physical unit; null unlinks it.

variantIdstring | null

Variant; null unlinks it.

spaceIdstring | null

Space; null unlinks it.

vehicleIdstring | null

Vehicle; null unlinks it.

orderIdstring | null

Order; null unlinks it.

projectIdstring | null

Project; null unlinks it.

contactIdsstring[]

Involved contacts. Replaces the list.

assigneeStaffIdsstring[]

Assigned staff. Replaces the list.

subscriberIdsstring[]

Deprecated: accepted for compatibility and ignored. Incidents no longer keep a subscriber list.

labelsstring[]

Labels. Replaces the list.

imagesstring[]

Photos of the damage. Replaces the list.

relatedIncidentIdsstring[]

Related incidents.

blockedByIncidentIdsstring[]

Incidents that block this one.

dueDatestring<date-time> | null

Target date, in ISO 8601 with offset; null clears it.

estimatedResolutionDatestring<date-time> | null

Estimated resolution date, in ISO 8601 with offset; null clears it.

actualResolutionDatestring<date-time> | null

Actual resolution date, in ISO 8601 with offset; null clears it.

reminderEnabledboolean

Enables the internal reminder.

reminderDatestring<date-time> | null

Reminder date, in ISO 8601 with offset; null clears it.

parentIncidentIdstring | null

Parent incident; null unlinks it.

idempotencyKeystring

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

ifMatchstring

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
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.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/incidents/{incidentId}.

  • Incidents

    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: true and the problem in the first text block. Branch on its code.