Ver categorias

Execuções

2 minutos de leitura

Operações relacionadas às Execuções – DoneForm

Listagem de Execuções #

GET /open_api/v1/done_forms

As respostas deste endpoint retornam os headers 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 Execuções.
end_date query string Filtro de data final das Execuções.
date_column query string Campo para filtragem de data [created_at, done_at, updated_at]. Padrão como a data de Criação Valores: created_at, updated_at, done_at Padrão: created_at
solution_id query array[integer] Filtro de solução dos Execuções.
department_ids query array[integer] Filtro de departamento das Execuções.
user_ids query array[integer] Filtro de id do usuário realizador.
form_ids query array[integer] Filtro de id do Formulário.
only_anonymous query boolean Filtro para retonar apenas formulários anônimos.
states query array[string] Filtro estado da Inspeção [concluded, in_progress, generated], por padrão filtrado por concluded. Valores: generated, in_process, to_review, to_approve, reproved, concluded
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, done_at, name Padrão: created_at
sort query string Retorna Formulários realizados ordenados 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 lista de Execução de Formulários

Lista de:

Campo Tipo Descrição
name string Nome da Execução
id integer Identificador da Execução
form_id integer Identificador da Do formulário de Origem
user_id integer Identificador do Usuário realizador
user_name integer Nome do Usuário
state string Estado da execução [concluído – concluded, em progresso – in_progress, gerado – generated]
score number Pontuação da execução
location object
Campo Tipo Descrição
latitude number Latitude
longitude number Longitude
full_address string Endereço estimado apartir da Geolocalização
department_id integer Identificador do departamento
done_at string Data da conclusão
created_at string Data de criação
updated_at string Data de atualização
done_items Checkbits_Entities_Index_DoneItem
Campo Tipo Descrição
id integer Identificador da Item da Execução
title string Título do item
sentence string Senteça do item
answer string Resposta do item
kind string Tipo de resposta do item
comment string Comentário do item
minimum string Valor Máximo do item
maximum string Valor Mínimo do item
weight number Peso do item
not_applied string Resposta do item
succeeded string Aprovação do Item

Exibe uma Execução #

GET /open_api/v1/done_forms/{id}

Retorna uma execução específica

Parâmetros #

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

Resposta (200) #

Retorna uma execução específica

Lista de:

Campo Tipo Descrição
name string Nome da Execução
id integer Identificador da Execução
form_id integer Identificador da Do formulário de Origem
user_id integer Identificador do Usuário realizador
user_name integer Nome do Usuário
state string Estado da execução [concluído – concluded, em progresso – in_progress, gerado – generated]
score number Pontuação da execução
location object
Campo Tipo Descrição
latitude number Latitude
longitude number Longitude
full_address string Endereço estimado apartir da Geolocalização
department_id integer Identificador do departamento
done_at string Data da conclusão
created_at string Data de criação
updated_at string Data de atualização
done_items Checkbits_Entities_Index_DoneItem
Campo Tipo Descrição
id integer Identificador da Item da Execução
title string Título do item
sentence string Senteça do item
answer string Resposta do item
kind string Tipo de resposta do item
comment string Comentário do item
minimum string Valor Máximo do item
maximum string Valor Mínimo do item
weight number Peso do item
not_applied string Resposta do item
succeeded string Aprovação do Item
Atualizado em 29.06.2026

Quais são seus sentimentos

  • Feliz
  • Normal
  • Triste
Rolar para cima