Listar atividades da ordem

GEThttps://carchost.fieldcontrol.com.br/orders/{id}/tasks

Lista as atividades de uma ordem de serviço, com paginação, filtros e ordenação.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: status:done.

Filtro	O que faz
status	Situação da atividade (scheduled, in-progress, done etc.).
employee_id	Identificador do colaborador responsável.
archived	true para arquivadas, false para ativas.
created_at	Data igual à informada (ISO 8601, UTC).
created_at>=	Criadas a partir da data informada, inclusive.
created_at<=	Criadas até a data informada, inclusive.
created_at>	Criadas depois da data informada.
created_at<	Criadas antes da data informada.
updated_at	Data igual à informada (ISO 8601, UTC).
updated_at>=	Alteradas a partir da data informada, inclusive.
updated_at<=	Alteradas até a data informada, inclusive.
updated_at>	Alteradas depois da data informada.
updated_at<	Alteradas antes da data informada.
completed_at	Data igual à informada (ISO 8601, UTC).
completed_at>=	Concluídas a partir da data informada, inclusive.
completed_at<=	Concluídas até a data informada, inclusive.
completed_at>	Concluídas depois da data informada.
completed_at<	Concluídas antes da data informada.
scheduled_date	Data igual à informada (ISO 8601, UTC).
scheduled_date>=	Agendadas a partir da data informada, inclusive.
scheduled_date<=	Agendadas até a data informada, inclusive.
scheduled_date>	Agendadas depois da data informada.
scheduled_date<	Agendadas antes da data informada.

sortstring

Ordenação. Prefixo - inverte a ordem.

Valores aceitos: id, created_at, -created_at, updated_at, -updated_at, scheduled_date, -scheduled_date.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

• 200

  Lista de atividades.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 404

  Recurso não encontrado. O corpo da resposta é vazio.

• 422

  Filtro, paginação ou ordenação inválidos (parametersValidationErr), ou identificador da ordem inválido (uriValidationErr).

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor.