Alertas

Listar

GET /api/v1/alerts

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Mais de um filtro pode ser passado na mesma consulta.

Este serviço suporta paginação.

start_date: a data de início dos alertas.
- Se passado, a consulta retorna somente alertas gerados a partir desta data e hora, inclusive.
- Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
- Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
- Este campo também suporta o formato ISO 8601.
- Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
end_date: a data final dos alertas.
- Se passado, a consulta retorna somente alertas gerados até esta data e hora, inclusive.
- Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
- Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
- Este campo também suporta o formato ISO 8601.
- Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
client_id: o id do cliente dos alertas.
- Se passado, a consulta retorna somente alertas ocorridos neste cliente.
location_id: o id do local dos alertas.
- Se passado, a consulta retorna somente alertas ocorridos neste local.
machine_id: o id da máquina dos alertas.
- Se passado, a consulta retorna somente alertas ocorridos nesta máquina.
machine_manufacturer_id: o id do fabricante das máquinas dos alertas.
- Se passado, a consulta retorna somente alertas ocorridos em máquinas deste fabricante.
installation_id: o id da instalação dos alertas.
- Se passado, a consulta retorna somente alertas ocorridos nesta instalação.
alert_id_greater_than: o id do alerta.
- Se passado, a consulta irá retornar somente os alertas com o id maior que o informado.
- Os campos start_date e end_date são desconsiderados caso este parâmetro seja informado.

Retorno

É retornado um JSON contendo um array com objetos que correspondem aos alertas. O array é ordenado por data e hora de alerta, da mais recente para a mais antiga. Os campos de cada alerta são os seguintes:

id: o id do alerta.
occurred_at: a data e hora do alerta, no formato ISO 8601.
client_id: o id do cliente do alerta.
location_id: o id do local do alerta.
machine_id: o id da máquina do alerta.
installation_id: o id da instalação do alerta.
title: o título do alerta.
description: a descrição do alerta.
client: detalhes do cliente do alerta.
location: detalhes do local do alerta.
machine: detalhes da máquina do alerta.
arguments: argumentos usados para gerar o alerta.

Segue um exemplo de retorno de consulta:

[
  {
    "id": 1,
    "occurred_at":"2016-02-11T12:34:56.000-02:00",
    "client_id": 1,
    "location_id": 2,
    "machine_id": 3,
    "installation_id": 4,
    "title": "Falha de comunicação"
    "description": "A comunicação falhou",
    "client": {
      "name":"Client X"
    },
    "location": {
      "client_id": 1,
      "name":"Location X"
    },
    "machine": {
      "machine_model_id": 9,
      "asset_number":"123"
    }
  },
  {
    "id": 2,
    "occurred_at":"2016-02-11T12:45:12.000-02:00",
    "client_id": 1,
    "location_id": 2,
    "machine_id": 3,
    "installation_id": 4,
    "title": "Retorno de comunicação"
    "description": "A comunicação foi restabelecida",
    "client": {
      "name":"Client X"
    },
    "location": {
      "client_id": 1,
      "name":"Location X"
    },
    "machine": {
      "machine_model_id": 9,
      "asset_number":"123"
    }
  },
  {
    "id": 3,
    "occurred_at":"2016-02-11T12:52:12.000-02:00",
    "client_id": 1,
    "location_id": 2,
    "machine_id": 3,
    "installation_id": 4,
    "title": "Quantidade baixa em canaleta",
    "description": "A quantidade está baixa (1) na canaleta 10 - COCA COLA  ZERO 1,5 LT",
    "client": {
      "name": "Client X"
  },
    "location": {
      "client_id": 1,
      "name": "X"
  },
    "machine": {
      "machine_model_id": 9,
      "asset_number": "123"
  },
    "arguments": {
      "quantity": { "number": 1.0 },
      "coil_number": "10",
      "occurred_at": "2016-02-11T12:52:12.000-02:00",
      "good": "COCA COLA  ZERO 1,5 LT",
      "category_id": 5,
      "upc_code": "7894900701753"
  }
]