Seção
7 funções do TermoSupport para seção.
// npm install termo_core --save-exact
import * as support from "termo_core/support";
// ou: import { support } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
buscar_paginador_secao | GET /secao | Lista as seções paginadas |
criar_secao | POST /secao | Cadastra uma seção (coluna do quadro) |
buscar_auto_complete_secao | GET /secao/autocomplete | Lista básica de seções para seleção |
buscar_pelo_filtro_secao | GET /secao/filtro | Busca seções por filtro |
buscar_pelo_id_secao | GET /secao/{id} | Busca uma seção pelo id |
atualizar_pelo_id_secao | PATCH /secao/{id} | Atualiza uma seção pelo id |
deletar_pelo_id_secao | DELETE /secao/{id} | Exclui uma seção pelo id |
buscar_paginador_secao
GET/secao Exige credencial
Lista as seções paginadas
Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Lista na ordem do quadro, sempre 50 por página: tamanho é ignorado. projeto_id limita a um projeto.
function buscar_paginador_secao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPaginadorSecao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaSecao>import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_secao(credencial_de_acesso, { projeto_id: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaSecao> · Rust: Result<tipos::PaginaSecao, ErroAoChamarServico> · veja PaginaSecao.
criar_secao
POST/secao Exige credencial
Cadastra uma seção (coluna do quadro)
Exige a permissão criar na área projetos. Cria a coluna no projeto. nome é obrigatório (até 80 caracteres). Sem ordem, entra no fim do quadro.
function criar_secao(
credencial_de_acesso: CredencialDeAcesso,
corpo_da_requisicao: tipos.SecaoCriar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Secao>import { CredencialDeAcesso } from "termo_core";
import { criar_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_secao(credencial_de_acesso, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Secao> · Rust: Result<tipos::Secao, ErroAoChamarServico> · veja Secao.
buscar_auto_complete_secao
GET/secao/autocomplete Exige credencial
Lista básica de seções para seleção
Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Devolve id e nome em ordem alfabética. projeto_id limita a um projeto e busca procura no nome.
function buscar_auto_complete_secao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarAutoCompleteSecao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaSecaoAutoComplete>import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_secao(credencial_de_acesso, { projeto_id: "..." });Argumentos
Nome
Tipo
Retorno: Promise<tipos.PaginaSecaoAutoComplete> · Rust: Result<tipos::PaginaSecaoAutoComplete, ErroAoChamarServico> · veja PaginaSecaoAutoComplete.
buscar_pelo_filtro_secao
GET/secao/filtro Exige credencial
Busca seções por filtro
Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Devolve as colunas na ordem do quadro. projeto_id limita a um projeto e nome procura o trecho no nome.
function buscar_pelo_filtro_secao(
credencial_de_acesso: CredencialDeAcesso,
parametros: ParametrosDeBuscarPeloFiltroSecao = {},
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.Secao>>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_secao(credencial_de_acesso, { projeto_id: "..." });Argumentos
Nome
Tipo
Retorno: Promise<Array<tipos.Secao>> · Rust: Result<Vec<tipos::Secao>, ErroAoChamarServico>
buscar_pelo_id_secao
GET/secao/{id} Exige credencial
Busca uma seção pelo id
Exige a permissão de leitura na área projetos (qualquer das ações ler, criar, editar ou deletar libera a leitura). Seção excluída não é encontrada.
function buscar_pelo_id_secao(
credencial_de_acesso: CredencialDeAcesso,
id: string,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Secao>import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_secao(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Secao> · Rust: Result<tipos::Secao, ErroAoChamarServico> · veja Secao.
atualizar_pelo_id_secao
PATCH/secao/{id} Exige credencial
Atualiza uma seção pelo id
Exige a permissão editar na área projetos. Renomeia (nome) ou reposiciona (ordem, decimal: para pôr entre duas colunas use a média das ordens delas).
function atualizar_pelo_id_secao(
credencial_de_acesso: CredencialDeAcesso,
id: string,
corpo_da_requisicao: tipos.SecaoAtualizar,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.Secao>import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_secao(credencial_de_acesso, id, corpo_da_requisicao);Argumentos
Nome
Tipo
Retorno: Promise<tipos.Secao> · Rust: Result<tipos::Secao, ErroAoChamarServico> · veja Secao.
deletar_pelo_id_secao
DELETE/secao/{id} Exige credencial
Exclui uma seção pelo id
Exige a permissão deletar na área projetos. Exclusão lógica: as tarefas da coluna vão para a primeira coluna que sobrar no projeto.
function deletar_pelo_id_secao(
credencial_de_acesso: CredencialDeAcesso,
id: string,
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_secao } from "termo_core/support";
const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_secao(credencial_de_acesso, id);Argumentos
Nome
Tipo
Retorno: Promise<void> · Rust: Result<(), ErroAoChamarServico> · sem corpo na resposta.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
PaginaSecao
import type { PaginaSecao } from "termo_core/support";
export interface PaginaSecao {
itens: Array<PaginaSecaoItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaSecaoAutoComplete
import type { PaginaSecaoAutoComplete } from "termo_core/support";
export interface PaginaSecaoAutoComplete {
itens: Array<PaginaSecaoAutoCompleteItensItem>;
pagina: number;
tamanho: number;
total: number;
}PaginaSecaoAutoCompleteItensItem
import type { PaginaSecaoAutoCompleteItensItem } from "termo_core/support";
export interface PaginaSecaoAutoCompleteItensItem {
id: string;
nome: string;
}PaginaSecaoItensItem
Uma coluna do quadro do projeto. A ordem é decimal para encaixar uma coluna entre duas sem
renumerar as outras.
import type { PaginaSecaoItensItem } from "termo_core/support";
export interface PaginaSecaoItensItem {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
ordem: number;
projeto_id: string;
}Secao
Uma coluna do quadro do projeto. A ordem é decimal para encaixar uma coluna entre duas sem
renumerar as outras.
import type { Secao } from "termo_core/support";
export interface Secao {
atualizado_em: string;
criado_em: string;
id: string;
nome: string;
ordem: number;
projeto_id: string;
}SecaoAtualizar
import type { SecaoAtualizar } from "termo_core/support";
export interface SecaoAtualizar {
nome?: string | null;
ordem?: number | null;
}SecaoCriar
import type { SecaoCriar } from "termo_core/support";
export interface SecaoCriar {
nome: string;
/**
* Sem ordem, a seção entra no fim do quadro.
*/
ordem?: number | null;
projeto_id: string;
}