Ver categorias

Formulários

2 minutos de leitura

Operações relacionadas aos Formulários – Form

Listagem paginada dos formulários cadastrados na plataforma #

GET /open_api/v1/forms

Este endpoint retorna uma lista paginada de formulários cadastrados na plataforma, permitindo a visualização dos principais dados de cada formulário.

  • É possível utilizar parâmetros de paginação para navegar entre os resultados.
  • Os headers da resposta incluem informações de paginação: link, current-page, page-items, total-pages, total-count.
  • Cada item da lista é serializado pela entity Checkbits::Entities::Index::Form.
  • É possível filtrar os formulários por departamento utilizando o parâmetro department_ids na query string. Exemplo: GET /api/v1/forms?department_ids=1,2,3.
  • É possível filtrar os formulários por outros departamentos utilizando o parâmetro other_department_ids na query string. Exemplo: GET /api/v1/forms?other_department_ids=1,2,3.

Exemplo de uso: #

GET /api/v1/forms?page=2&page_items=20&department_ids=1,2,3&other_department_ids=4,5,6

Parâmetros #

Parâmetro Em Tipo Obrig. Descrição
start_date query string Filtro de data inicial dos Formulários.
end_date query string Filtro de data final dos Formulários.
date_column query string Seleção de campo que será filtrada a data. Valores: created_at, updated_at Padrão: created_at
ids formData array[integer] Filtro de ids dos Formulários.
solution_id formData array[integer] Filtro de solução dos Formulários.
department_ids formData array[integer] Filtro de departamento dos Formulários.
other_department_ids formData array[integer] Filtro de utros departamentos dos Formulários.
order_by query string Retorna Formulários realizados ordenados por created_at, done_at, updated_at ou name. Padrão para created_at. Valores: created_at, updated_at, name Padrão: created_at
sort query string Retorna Formulários realizados ordenados de forma ascencente 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 lista de Formulários

Lista de:

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

Detalhes de um formulário #

GET /open_api/v1/forms/{id}

Retorna dados de um Formulário específico

Parâmetros #

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

Resposta (200) #

Retorna dados de um Formulário específico

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
Atualizado em 29.06.2026

Quais são seus sentimentos

  • Feliz
  • Normal
  • Triste
Rolar para cima