Consultar os tempos de execução das tarefas no OS

get

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

Consultar as informações detalhadas de uma lista de ativos ou de um ativo específico. Por meio desta API é possível consultar o detalhe dos tempos utilizados para a execução de uma tarefa dentro de uma ordem de trabalho.

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

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
`id_work_order_task`	número inteiro	Opcional	Id da tarefa na ordem de trabalho. Pode ser consultado aqui. (campo `id_work_orders_tasks`)
`id_work_order`	número inteiro	Opcional	Id da ordem de trabalho. Pode ser consultado aqui. (campo `id_work_order`)
`since`	texto	Opcional	Novo. Data inicial do intervalo de filtro. Formato ISO 8601, exemplo: `2023-08-01T20:00:00-03`. Se enviado junto com `until` mas sem `type_date`, filtra por `initial_date` ou `final_date` dentro do intervalo.
`until`	texto	Opcional	Novo. Data final do intervalo de filtro. Formato ISO 8601, exemplo: `2023-08-01T20:00:00-03`. Só tem efeito junto com `since`.
`type_date`	texto	Opcional	Novo. Campo de data sobre o qual se aplica o filtro `since`/`until`. Valores permitidos: `creation_date`, `date_maintenance`, `cal_date_maintenance`, `initial_date`, `final_date`, `review_date`, `wo_final_date`. Alias aceito: `property_date`. Um valor não listado responde `400`.
`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.

Parâmetros de saída

Nota: Todas as datas retornadas pelos serviços web da Fracttal estão em UTC-0.

Parâmetro	Tipo	Descrição
`id_work_order_task`	inteiro	Id da tarefa dentro da OT
`initial_date`	texto	Data de início da execução da tarefa
`final_date`	texto	Data de finalização da execução da tarefa
`id_wo_tasks_execution_types`	inteiro	Id do tipo de execução atribuído ao registro. Retorna null se nenhum tipo foi atribuído.
`wo_tasks_execution_types_description`	texto	Descrição do tipo de execução. Retorna null se nenhum tipo foi atribuído, se a empresa não tem a categorização de tempos ativada, ou se o tipo foi excluído do catálogo.
`note`	texto	Nota do registro de execução. Retorna null se nenhuma nota foi inserida.
`name`	texto	Nome da pessoa que registrou o tempo
`id_account`	inteiro	Id da conta que registrou a execução da tarefa
`id_personnel`	inteiro	Id do recurso humano (caso a conta esteja vinculada a um recurso humano)
`personnel_code`	texto	Código do recurso humano (caso a conta esteja vinculada a um recurso humano)
`third_party_id`	inteiro	Id do terceiro (caso a conta esteja vinculada a um terceiro)
`third_party_code`	texto	Código do terceiro (caso a conta esteja vinculada a um terceiro)
`third_party_contact_name`	texto	Nome do contato do terceiro (caso a conta esteja vinculada a um terceiro)
`execution_events`	array	Array de eventos do bloco de execução, ordenado por id decrescente (evento mais recente primeiro). Ver estrutura a seguir.

Estrutura de cada evento em execution_events

Parâmetro Tipo Descrição
id inteiro ID do evento de execução
action_type inteiro Tipo de ação: 0 = PAUSED, 1 = IN_PROGRESS
action_type_description texto Descrição textual: "PAUSED" ou "IN_PROGRESS"
id_wo_tasks_execution_types inteiro ID do tipo de execução atribuído ao evento; null se não aplicável. Permanece mesmo que o tipo seja excluído do catálogo.
paused_reason_description texto Descrição do motivo da pausa; null se não aplicável ou se o tipo foi excluído do catálogo (resolvido em tempo real, não é um snapshot).
initial_date texto Data e hora de início do evento (UTC-0)
final_date texto Data e hora de fim do evento (UTC-0)
note texto Nota do evento; null se não foi inserida
duration_seconds inteiro Duração do evento em segundos

Erros

Código	Causa
`400`	`type_date` (ou seu alias `property_date`) com um valor fora da lista permitida.
`400`	`since`, `until`, `id_work_order_task` ou `id_work_order` com um valor que não corresponde ao formato esperado.
`404`	`id_work_order` não existe na empresa do caller.

Exemplo

Response `200`

{
  "success": true,
  "message": "200",
  "data": [
    {
      "id": 8271217,
      "id_company": 1190,
      "id_work_order_task": 13951616,
      "initial_date": "2023-03-27T16:43:14.296123+00:00",
      "final_date": "2023-03-27T16:48:32.809057+00:00",
      "id_wo_tasks_execution_types": 3,
      "wo_tasks_execution_types_description": "Búsqueda de material",
      "note": "Nota del registro",
      "id_account": 3,
      "name": "JUAN PÉREZ",
      "id_personnel": 1539,
      "personnel_code": "RH-001",
      "third_party_id": null,
      "third_party_code": null,
      "third_party_contact_name": null,
      "execution_events": [
        {
          "id": 100203,
          "action_type": 1,
          "action_type_description": "IN_PROGRESS",
          "id_wo_tasks_execution_types": null,
          "paused_reason_description": null,
          "initial_date": "2023-03-27T16:46:30.000000+00:00",
          "final_date": "2023-03-27T16:48:32.809057+00:00",
          "note": null,
          "duration_seconds": 122
        },
        {
          "id": 100197,
          "action_type": 0,
          "action_type_description": "PAUSED",
          "id_wo_tasks_execution_types": 3,
          "paused_reason_description": "Búsqueda de material",
          "initial_date": "2023-03-27T16:45:00.000000+00:00",
          "final_date": "2023-03-27T16:46:30.000000+00:00",
          "note": "Falta insumos",
          "duration_seconds": 90
        }
      ]
    }
  ],
  "total": 1
}

Response — filtrando por intervalo de datas (`200`)

Requisição: GET /api/wo_execution_times/?id_work_order=34973667&since=2023-01-01T00:00:00-03&until=2023-03-31T23:59:59-03&type_date=initial_date

{
  "success": true,
  "message": "200",
  "data": [
    {
      "id": 8271217,
      "id_work_order_task": 13951616,
      "initial_date": "2023-03-27T16:43:14.296123+00:00",
      "final_date": "2023-03-27T16:48:32.809057+00:00",
      "execution_events": []
    }
  ],
  "total": 1
}

Response — erro, `type_date` inválido (`400`)

Requisição: GET /api/wo_execution_times/?type_date=data_invalida

{
  "success": false,
  "message": "400",
  "data": [
    {
      "ERROR": "Validation failed. Invalid fields",
      "invalid_fields": [
        { "field": "type_date", "field_message": "type_date value is not correct", "field_validation": "CUSTOM" }
      ]
    }
  ],
  "total": 0
}

Response — erro, `id_work_order` inexistente (`404`)

Requisição: GET /api/wo_execution_times/?id_work_order=999999999

{
  "success": false,
  "message": "404",
  "data": [
    { "ERROR": "Work order id 999999999 was not found in your company" }
  ],
  "total": 0
}

Language

Loading…