# Opções de classificação (https://docs.pulsarml.com/pt/v1/api-reference/stops/get-stops-classification-options)

**Scope necessário:** `stop_catalogs.read`.

Lista, por máquina, as classificações que `PUT /v1/stops/classifications` aceita para as suas paragens:

* `generalCauses`: as causas gerais da árvore de perdas da máquina, cada uma com as `specificCauses` que podem ficar abaixo dela.
* `components`: os componentes atribuídos à máquina.

Uma máquina sem árvore de perdas não tem causas gerais; às suas paragens só pode ser dada uma `description`. Restrinja a lista com `machineId`, repetido para várias máquinas:

```
GET /v1/stops/classification-options?machineId=12&machineId=13
```

## `GET /v1/stops/classification-options`

Base URLs:
- `https://draco.prod.pulsarml.com` — Produção
- `https://draco.stage.pulsarml.com` — Sandbox (staging)

Authentication: send your API key in the `x-api-key` header.

### Query parameters

- `machineId` (array of integer, optional, nullable) — Apenas estas máquinas, tal como devolvidas por `GET /v1/machines`. Repita-o para várias máquinas (`machineId=12&machineId=13`). Todas as suas máquinas quando omitido.

### Responses

#### 200 — Uma entrada por máquina

Type: array of object

- `machineId` (integer, required, e.g. `12`) — O ID da máquina, tal como devolvido por `GET /v1/machines`.
- `generalCauses` (array of object, required) — As causas gerais que as paragens da máquina aceitam, da sua árvore de perdas. Vazio quando a máquina não tem árvore de perdas; nesse caso, as suas paragens só podem ser classificadas com uma `description`.
  - `id` (string (uuid), required, e.g. `"f89b5866-2d26-45a1-8cfc-8295557594d8"`) — O id da opção.
  - `name` (string, required, e.g. `"Bearing failure"`) — O nome da opção.
  - `specificCauses` (array of object, required) — As causas específicas que podem acompanhar esta causa geral na máquina. Vazio quando não aceita nenhuma.
    - `id` (string (uuid), required, e.g. `"f89b5866-2d26-45a1-8cfc-8295557594d8"`) — O id da opção.
    - `name` (string, required, e.g. `"Bearing failure"`) — O nome da opção.
- `components` (array of object, required) — Os componentes que podem ser indicados nas paragens da máquina.
  - `id` (string (uuid), required, e.g. `"f89b5866-2d26-45a1-8cfc-8295557594d8"`) — O id da opção.
  - `name` (string, required, e.g. `"Bearing failure"`) — O nome da opção.

#### 401 — * `unauthenticated`: as credenciais estão em falta, são inválidas ou expiraram.

#### 403 — * `missing_scope`: as credenciais são válidas, mas não têm o scope que este endpoint requer.

#### 422 — Erro de validação

Type: object (`HTTPValidationError`)

- `detail` (array of object, optional)
  - `loc` (array of string | integer, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any, optional)
  - `ctx` (object, optional)

#### 429 — * `rate_limited`: a chave de API excedeu o seu limite de pedidos. Tente novamente após `Retry-After` segundos.

### Example request

```bash
curl -X GET 'https://draco.prod.pulsarml.com/v1/stops/classification-options' \
  -H 'x-api-key: <YOUR_API_KEY>'
```