Consultar tarefas pendentes

get

https://app.fracttal.com/api/tasks_todo/

Por meio desta API é possível consultar a lista de tarefas pendentes. É possível filtrar por data programada; por padrão, mostra as tarefas pendentes em um intervalo de 1 mês.

GET https://app.fracttal.com/api/tasks_todo

Parâmetros de entrada

As informações podem ser filtradas através dos seguintes query_params. Todos são opcionais.

Parâmetro	Tipo	Obrigatório	Descrição
`until`	texto	Opcional	Data final da consulta. Formato: `YYYY-MM-DDTHH:MM:SS-UTC`. Exemplo: `2016-07-12T20:00:00-03`. (Padrão: um mês).
`code_location`	texto	Opcional	Código da localização do ativo. Pode ser consultado aqui. (campo `code`)
`start`	número inteiro	Opcional	Número do registro onde a consulta iniciará. Padrão 0. Todas as consultas estão limitadas a 100 registros; use este parâmetro para a paginação.
`limit`	número inteiro	Opcional	Quantidade de registros que a solicitação mostrará. Padrão 100.
`since`	texto	Opcional	Data inicial da consulta. Formato: `YYYY-MM-DDTHH:MM:SS-UTC`. Exemplo: `2016-07-12T20:00:00-03`.
`include_out_of_service`	booleano	Opcional	Novo. Filtra as tarefas conforme o ativo associado tenha um período "Fora de Serviço" ativo (registrado em Disponibilidade de Ativos). `true`: apenas tarefas com período ativo. `false`: apenas tarefas sem período ativo. Se omitido ou enviado vazio, retorna todas as tarefas sem filtrar por esse critério. Aceita `true`/`false`/`1`/`0` (sem diferenciar maiúsculas/minúsculas).

Alias de include_out_of_service
Também são aceitos como alias id_items_availability, out_of_service e asset_out_of_service — é usado o primeiro valor não vazio recebido, nessa ordem de prioridade.

Parâmetros de saída

Parâmetro	Tipo	Descrição
`id_task`	inteiro	Id da tarefa
`id_item`	inteiro	Id do ativo
`item_description`	texto	Descrição do ativo
`code`	texto	Código do ativo
`group_task_description`	texto	Plano de tarefas
`is_active`	booleano	Indica se o ativo está ativo
`visible_to_all`	texto	Ativo visível para todos
`parent_description`	texto	Localização do ativo
`date_maintenance`	texto	Data calculada
`trigger_description`	texto	Evento que executou a tarefa
`delay`	texto	Tempo de atraso
`description`	texto	Descrição da tarefa
`duration`	texto	Duração estimada em segundos
`tasks_types_main_description`	texto	Tipo de tarefa
`priorities_description`	texto	Prioridade da tarefa
`tasks_types_description`	texto	Classificação 1 da tarefa
`tasks_types_2_description`	texto	Classificação 2 da tarefa
`num_resources`	texto	Quantidade de recursos na tarefa
`last_date_maintenance`	texto	Última data de programação
`task_note`	texto	Nota da tarefa
`requested_by`	texto	Solicitado por (se a tarefa foi executada a partir de uma solicitação)
`id_request`	texto	Id da solicitação (se a tarefa foi executada a partir de uma solicitação)
`event_date`	texto	Data do evento
`cal_date_maintenance`	texto	Data programada
`replay_counter`	inteiro	Número de execuções da tarefa
`replay_counter_cycles`	inteiro	Número de execuções no ciclo
`num_iterations`	inteiro	Última iteração executada
`out_of_service`	booleano	Novo. Indica se o ativo da tarefa tem um período "Fora de Serviço" ativo no momento da consulta (sem data de término, ou com data de término futura). Sempre retornado, o filtro sendo enviado ou não.
`asset_out_of_service`	booleano	Novo. Mesmo valor de `out_of_service` (mesmo cálculo, campo duplicado).

Erros

Código	Causa
`400`	O parâmetro de filtro (`include_out_of_service` ou qualquer um de seus alias) recebeu um valor não booleano. Mensagem real: `Parameter id_items_availability (or out_of_service, include_out_of_service, asset_out_of_service) must be a boolean (true, false, 1 or 0). Received: "<valor_enviado>"`

Exemplo

Response `200`

{
  "success": true,
  "message": "200",
  "data": [
    {
      "id": 1163,
      "id_task": 986,
      "id_item": 49210,
      "item_description": "MAQUINA 1      { AMCO-01 }",
      "code": "AMCO-01",
      "group_task_description": "Mantenimiento Línea de Producción",
      "is_active": true,
      "visible_to_all": false,
      "parent_description": "// AMCO/ ",
      "date_maintenance": "2021-08-26T05:00:00+00:00",
      "trigger_description": "DATE$EVERY$5$MONTHS",
      "delay": 77,
      "description": "Manto vehículo",
      "duration": 600,
      "tasks_types_main_description": "Mantenimiento",
      "num_resources": 0,
      "last_date_maintenance": "2021-03-26T05:00:00+00:00",
      "cal_date_maintenance": "2021-08-26T05:00:00+00:00",
      "replay_counter": 0,
      "out_of_service": false,
      "asset_out_of_service": false
    }
  ],
  "total": 1
}

Response — filtrando por ativos fora de serviço (`200`)

Requisição: GET /api/tasks_todo/?include_out_of_service=true

{
  "success": true,
  "message": "200",
  "data": [
    {
      "id": 1163,
      "id_task": 986,
      "id_item": 49210,
      "code": "AMCO-01",
      "out_of_service": true,
      "asset_out_of_service": true
    }
  ],
  "total": 1
}

Response — erro, valor não booleano (`400`)

Requisição: GET /api/tasks_todo/?include_out_of_service=talvez

{
  "success": false,
  "message": "400",
  "data": [
    { "ERROR": "Parameter id_items_availability (or out_of_service, include_out_of_service, asset_out_of_service) must be a boolean (true, false, 1 or 0). Received: \"talvez\"" }
  ],
  "total": 0
}

Response

200

Language

Loading…