Incidents
Count incidents by status
Returns how many incidents there are in each status, with optional filters by project, space, vehicle, item, physical unit or order.
Request examples
curl https://app.filmo.io/api/v1/incidents/status-counts \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
The six keys always come out, with 0 if there are none. It is the only way to discover the volume: this resource does not publish a listing.
Authorizations
Bearer API key with the scope below. incidents:read
Headers
Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Query parameters
Filter by project.
Limits: min length 1, max length 100
Filter by space.
Limits: min length 1, max length 100
Filter by vehicle.
Limits: min length 1, max length 100
Filter by catalog item.
Limits: min length 1, max length 100
Filter by physical unit.
Limits: min length 1, max length 100
Filter by order.
Limits: min length 1, max length 100
Response
Successful response.
Response schema: IncidentStatusCountsDto
Envelope: IncidentStatusCountsResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
How many incidents there are in each status. All six keys are always returned, with 0 when there are none.
Show child attributesHide child attributes
Incidents in draft.
Open incidents.
Waiting incidents.
Incidents under repair.
Resolved incidents.
Material declared lost.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Not modified: the If-None-Match sent matches the current ETag. No body; the copy you have is current.
Headers: ETag
No body.
Invalid request (validation_error): malformed query or body. errors[] lists every offending field with its stable code.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Add-on required (addon_required): the account plan does not include the add-on this operation needs; requiredAddon names it.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
| Status | Codes | Meaning |
|---|---|---|
| 400 | validation_error | Malformed query or body. errors[] lists every offending field with its stable code. |
| 402 | addon_required | The account plan does not include the add-on this operation needs; requiredAddon names it. |
401, 403, 429, 500 can be returned by any operation. Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related
Was this page helpful?