Ver categorias

Tarefas

2 minutos de leitura

Operações relacionadas às Tasks

Listagem de Tasks com filtros e paginação #

GET /open_api/v1/tasks

Este endpoint retorna uma lista paginada de tasks, permitindo filtrar por datas, status, solução, departamento, usuário responsável e formulário.

Os resultados podem ser ordenados por diferentes campos e em ordem ascendente ou descendente.

Filtros disponíveis: #

  • start_date e end_date: intervalo de datas para o campo definido em date_column
  • date_column: campo de data a ser filtrado (created_at, updated_at, start_at, end_at)
  • department_ids: filtra por departamentos
  • user_ids: filtra por usuários responsáveis
  • form_ids: filtra por formulários
  • statuses: filtra por status da task

Ordenação: #

  • order_by: campo para ordenação (created_at, updated_at, start_at, end_at)
  • sort: direção da ordenação (asc, desc)

Paginação: #

  • Parâmetros de paginação padrão disponíveis.

Os headers da resposta incluem informações de paginação: link, current-page, page-items, total-pages, total-count.

Parâmetros #

Parâmetro Em Tipo Obrig. Descrição
start_date query string Filtro de data inicial das Tasks.
end_date query string Filtro de data final das Tasks.
date_column query string Campo para filtragem de data [created_at, start_at, end_at, updated_at]. Padrão como a data de Criação Valores: created_at, updated_at, start_at, end_at Padrão: created_at
solution_id query array[integer] Filtro de solução das Tasks.
department_ids query array[integer] Filtro de departamento das Tasks.
user_ids query array[integer] Filtro de id do usuário responsável.
form_ids query array[integer] Filtro de id do Formulário.
status query array[string] Filtro estado da Task [on_hold, open, done, overdue, done_overdue, excluded] Valores: on_hold, open, done, overdue, done_overdue, excluded
order_by query string Retorna Tasks ordenadas por created_at, updated_at, start_at, end_at. Valores: created_at, updated_at, start_at, end_at Padrão: created_at
sort query string Retorna Tasks ordenadas de forma ascendente ou descendente [asc, desc]. Valores: asc, desc Padrão: desc
page query integer Page offset to fetch. Padrão: 1
items query integer Number of items to return per page. Maximum value: 100 Padrão: 20

Resposta (200) #

Retorna uma lista paginada de tasks geradas, permitindo diversos filtros e ordenação.

Lista de:

Campo Tipo Descrição
schedule_id integer ID do agendamento relacionado à task (schedule).
status string Status atual da task. Um dos [on_hold, open, done, overdue, done_overdue, excluded]
start_at string Data e hora de início da task. Formato: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
end_at string Data e hora de término da task. Formato: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
form_name string Nome do formulário associado à task.
form_id integer ID do formulário associado à task.
comment string Comentário ou observação da task.
user_names string Nomes dos responsáveis pela task, separados por vírgula.
user_ids array[string] IDs dos usuários responsáveis pela task.
department_id integer ID do departamento associado à task.

Agenda de tarefas com filtros e paginação #

GET /open_api/v1/tasks/agenda

Este endpoint retorna uma lista de agendamentos (agenda) de tarefas, permitindo ao usuário visualizar as tarefas programadas agrupadas por data, usuário, departamento ou outros critérios.

Funcionalidades: #

  • Visualização dos agendamentos de tarefas em formato de agenda.
  • Permite aplicar filtros para refinar a busca conforme necessidade do usuário.
  • Ideal para construção de calendários, dashboards ou painéis de acompanhamento de tarefas.

Resposta: #

  • A resposta é uma lista de objetos representando os agendamentos, serializados pela entity Checkbits::Entities::Index::Agenda.

Parâmetros #

Parâmetro Em Tipo Obrig. Descrição
start_date query string Filtro de data inicial Agenda. Intervalo de no máximo 90 dias.
end_date query string Filtro de data final das Agenda. Intervalo de no máximo 90 dias.
solution_id query array[integer] Filtro de solução
department_ids query array[integer] Filtro de departamento das Tasks.
user_ids query array[integer] Filtro de id do usuário responsável.
form_ids query array[integer] Filtro de id do Formulário.

Resposta (200) #

Retorna uma lista de agendamentos de tarefas, permitindo visualização agrupada por data e outros filtros.

Lista de:

Campo Tipo Descrição
name string Nome do agendamento ou evento.
schedule_id integer ID do agendamento relacionado à agenda.
status string Status atual do agendamento.
start_date string Data e hora de início do agendamento. Formato: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
end_date string Data e hora de término do agendamento. Formato: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
form_name string Nome do formulário associado ao agendamento.
form_id integer ID do formulário associado ao agendamento.
description string Descrição do agendamento.
user_names string Nomes dos responsáveis pelo agendamento, separados por vírgula.
task_id integer ID da task relacionada ao agendamento, caso já tenha sido criada
task_status string Status da task relacionada ao agendamento, caso já tenha sido criada.
department_id integer ID do departamento associado ao formulário do agendamento.
Atualizado em 29.06.2026

Quais são seus sentimentos

  • Feliz
  • Normal
  • Triste
Rolar para cima