Ver categorias

Schedules

2 minutos de leitura

Operations about Schedules

Listagem de Schedules. #

GET /open_api/v1/schedules

Retorna lista de Schedules

Parâmetros #

Parâmetro Em Tipo Obrig. Descrição
form_ids formData array[integer] Filtro de id do Formulário.
user_ids formData array[integer] Filtro de id dos usuários responsáveis.
order_by query string Campo para ordenação. Valores: name, created_at, updated_at, next_start_at, next_end_at Padrão: created_at
sort query string Direção da ordenação. 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 lista de Schedules

Lista de:

Campo Tipo Descrição
id integer ID do Schedule
name string Nome do Schedule
status string Status do Schedule, um dos seguintes: enabled, disabled, excluded, concluded
duration integer Duração do agendamento em segundos
start_date string Data de início
end_date string Data de término
form_id integer ID do Formulário
form_name string
description string Descrição
user_ids array[integer] IDs dos funcionários
next_start_at string Data de início do próximo agendamento
next_end_at string Data de término do próximo agendamento

Exibe um Schedule #

GET /open_api/v1/schedules/{id}

Retorna um Schedule específico

Parâmetros #

Parâmetro Em Tipo Obrig. Descrição
id path integer ✔ ID do Schedule

Resposta (200) #

Retorna um Schedule específico

Campo Tipo Descrição
id integer ID do agendamento.
name string Nome do agendamento.
status string Status atual do agendamento.
start_date string Data e hora de início do agendamento. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
end_date string Data e hora de término do agendamento. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
description string Descrição do agendamento.
form Checkbits_Entities_Index_Form Formulário associado ao agendamento.

Campo Tipo Descrição
id integer Identificador do formulário
name string Nome do Formulário
description string Descrição do Formulário
department object
Campo Tipo Descrição
id integer Identificador do departamento
name string Nome do Departamento
other_departments array Outros departamentos associados ao formulário
user_emails array[string] E-mails dos usuários responsáveis pelo formulário.
created_at string Data de Criação
updated_at string Data de Atualização
users array[Checkbits_Entities_Index_User] Lista de usuários associados ao agendamento.
next_start_at string Data e hora da próxima ocorrência de início. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
next_end_at string Data e hora da próxima ocorrência de término. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
created_at string Data e hora de criação do agendamento. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
updated_at string Data e hora da última atualização do agendamento. Formato: YYYY-MM-DDTHH:MM:SS.mmm±hh:mm (ex: 2022-11-11T08:35:00.000-03:00, timezone de Brasília).
Atualizado em 29.06.2026

Quais são seus sentimentos

  • Feliz
  • Normal
  • Triste
Rolar para cima