Ver categorias

Planos de Ação

2 minutos de leitura

Operations about Planos de Açãos

Listagem de Planos de Ação #

GET /open_api/v1/action_plans

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 dos Planos de Ação.
end_date query string Filtro de data final dos Planos de Ação.
date_column query string Campo para filtragem de data [created_at, dead_line, updated_at]. Padrão como a data de Criação Valores: created_at, updated_at, dead_line Padrão: created_at
form_ids query array[integer] Filtro por IDs dos Formulários
done_form_ids query array[integer] Filtro por IDs dos Formulários Realizados
emitter_ids query array[integer] Filtro por IDs dos Emissores
receiver_ids query array[integer] Filtro por IDs dos Receptores
status query array[string] Filtro por status do Plano de Ação [opened, waiting, closed] Valores: opened, waiting, closed
order_by query string Ordenação por [created_at, dead_line, updated_at]. Padrão para created_at. Valores: created_at, updated_at, dead_line Padrão: created_at
sort query string Ordem de classificação [asc, desc]. Padrão para 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 listagem de planos de ação

Lista de:

Campo Tipo Descrição
id string
done_form_id string
form_id string
status string
level string
dead_line string
created_at string
updated_at string
done_item 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
emitter Checkbits_Entities_Index_User
Campo Tipo Descrição
id integer ID do usuário.
name string Nome do usuário.
email string E-mail do usuário.
status string Status do usuário.
roles array[string] Lista de papéis (roles) atribuídos ao usuário.
receivers Checkbits_Entities_Index_User
Campo Tipo Descrição
id integer ID do usuário.
name string Nome do usuário.
email string E-mail do usuário.
status string Status do usuário.
roles array[string] Lista de papéis (roles) atribuídos ao usuário.
what string
why string
where string
how string
how_much string

Exibe um Plano de Ação #

GET /open_api/v1/action_plans/{id}

Retorna um plano de ação específico

Parâmetros #

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

Resposta (200) #

Retorna um plano de ação específico

Campo Tipo Descrição
id string
done_item_id string
form_id string
done_form_id string
status string
level string
dead_line string
created_at string
updated_at string
emitter Checkbits_Entities_Index_User
Campo Tipo Descrição
id integer ID do usuário.
name string Nome do usuário.
email string E-mail do usuário.
status string Status do usuário.
roles array[string] Lista de papéis (roles) atribuídos ao usuário.
receivers Checkbits_Entities_Index_User
Campo Tipo Descrição
id integer ID do usuário.
name string Nome do usuário.
email string E-mail do usuário.
status string Status do usuário.
roles array[string] Lista de papéis (roles) atribuídos ao usuário.
what string
why string
where string
how string
how_much string
comments Checkbits_Entities_Show_Comments
Campo Tipo Descrição
id string
body string
created_at string
user_id string
file_url string
file_kind string
Atualizado em 29.06.2026

Quais são seus sentimentos

  • Feliz
  • Normal
  • Triste
Rolar para cima