List how each machine's stops can be classified
Required scope: stop_catalogs.read.
List, per machine, the classifications PUT /v1/stops/classifications accepts for its stops:
generalCauses: the general causes of the machine's loss tree, each with thespecificCausesthat can go under it.components: the components assigned to the machine.
A machine without a loss tree has no general causes; its stops can only be given a
description. Narrow the list with machineId, repeated for several machines:
GET /v1/stops/classification-options?machineId=12&machineId=13
Query Parameters
Only these machines, as returned by GET /v1/machines. Repeat it for several machines (machineId=12&machineId=13). All of your machines when omitted.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/stops/classification-options"[ { "machineId": 12, "generalCauses": [ { "id": "f89b5866-2d26-45a1-8cfc-8295557594d8", "name": "Bearing failure", "specificCauses": [ { "id": "f89b5866-2d26-45a1-8cfc-8295557594d8", "name": "Bearing failure" } ] } ], "components": [ { "id": "f89b5866-2d26-45a1-8cfc-8295557594d8", "name": "Bearing failure" } ] }]List stop components GET
List the components of your stop catalog: the part of a machine a stop is attributed to. Components are assigned to machines; use GET /v1/stops/classification-options for the components of a given machine.
Classify stops PUT
Classify stops: set their general cause, specific cause, component and description. The body is a JSON array of up to 1,000 rows, each its own classification. Identifying a stop. A stop is identified by its machine and the time it started, not by an id: stop ids can change when a shift is recalculated. Take machine.id and stop.startTime from POST /v1/reports/stops. Open stops, still running, can be classified too. Choosing a classification. Each machine accepts only the causes of its loss tree and its own components, listed by GET /v1/stops/classification-options. A row sets at least a generalCauseId or a description; specificCauseId needs a generalCauseId. A row replaces the stop's classification. Whatever a row leaves out is cleared: sending only generalCauseId removes the stop's specific cause, component and description. Sending the same rows again is harmless, so a request that timed out can be retried as is. A cause set by an operator in Pulsar is overwritten too. Every row comes back with a status, and only classified rows changed anything: * classified: the stop now has this classification. * stopNotFound: machine machineId has no stop that started at startTime, or it is not one of your machines. * duplicateStop: another row in the same request names the same stop, so neither was applied. * generalCauseNotAvailable: the general cause is not in the machine's loss tree. * specificCauseNotAvailable: the specific cause does not go under the general cause on this machine. * componentNotAvailable: the component is not assigned to the machine. The schema also lists missingClassification and missingGeneralCause. This endpoint rejects such rows with 422 before they reach Pulsar, so you will not receive them. Result rows echo your rows in request order, with startTime normalized to UTC; match them by position rather than by comparing startTime strings. The classified rows of a request are saved together. Metrics that depend on the stops' causes are recalculated in the background, so reports may take a moment to show the change.