Visão geralServiçosEventosRecursos
TermoPortal

Tabela auxiliar

7 funções do TermoPortal para tabela auxiliar.

// npm install termo_core --save-exact
import * as portal from "termo_core/portal";
// ou: import { portal } from "termo_core";
FunçãoRotaO que faz
buscar_paginador_tabela_auxiliarGET /tabela_auxiliarLista os valores auxiliares paginados
criar_tabela_auxiliarPOST /tabela_auxiliarCadastra um valor auxiliar
buscar_auto_complete_tabela_auxiliarGET /tabela_auxiliar/autocompleteLista básica de valores de um campo para seleção
buscar_pelo_filtro_tabela_auxiliarGET /tabela_auxiliar/filtroBusca valores auxiliares por filtro
buscar_pelo_id_tabela_auxiliarGET /tabela_auxiliar/{id}Busca um valor auxiliar pelo id
atualizar_pelo_id_tabela_auxiliarPATCH /tabela_auxiliar/{id}Atualiza o label de um valor auxiliar
deletar_pelo_id_tabela_auxiliarDELETE /tabela_auxiliar/{id}Exclui um valor auxiliar

buscar_paginador_tabela_auxiliar

GET/tabela_auxiliar Exige credencial

Lista os valores auxiliares paginados

Exige sessão. Ordenado por tabela, campo e label. tabela e campo filtram (opcionais). Paginado com 50 itens por página (fixo); pagina começa em 1. A resposta traz itens, total, pagina e tamanho.

function buscar_paginador_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPaginadorTabelaAuxiliar = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaTabelaAuxiliar>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_paginador_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_paginador_tabela_auxiliar(credencial_de_acesso, { tabela: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaTabelaAuxiliar> · Rust: Result<tipos::PaginaTabelaAuxiliar, ErroAoChamarServico> · veja PaginaTabelaAuxiliar.

criar_tabela_auxiliar

POST/tabela_auxiliar Exige credencial

Cadastra um valor auxiliar

Exige o módulo Configuracoes (criar). Valor de um campo que chega das integrações sem cadastro próprio (ex.: tabela=produto, campo=marca_tiny). tabela, campo e label obrigatórios; o trio é único. A sincronização do catálogo preenche a tabela sozinha.

function criar_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  corpo_da_requisicao: tipos.TabelaAuxiliarCriar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.TabelaAuxiliar>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { criar_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await criar_tabela_auxiliar(credencial_de_acesso, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.TabelaAuxiliar> · Rust: Result<tipos::TabelaAuxiliar, ErroAoChamarServico> · veja TabelaAuxiliar.

buscar_auto_complete_tabela_auxiliar

GET/tabela_auxiliar/autocomplete Exige credencial

Lista básica de valores de um campo para seleção

Exige sessão. tabela e campo obrigatórios (ex.: produto e marca_tiny). Devolve só id e label, em ordem alfabética. busca procura no label. tamanho tem padrão 10 e vai de 1 a 50; pagina começa em 1. A resposta traz itens, total, pagina e tamanho.

function buscar_auto_complete_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteTabelaAuxiliar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaTabelaAuxiliarAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_auto_complete_tabela_auxiliar(credencial_de_acesso, { tabela, campo });

Argumentos

Nome

Tipo

Retorno: Promise<tipos.PaginaTabelaAuxiliarAutoComplete> · Rust: Result<tipos::PaginaTabelaAuxiliarAutoComplete, ErroAoChamarServico> · veja PaginaTabelaAuxiliarAutoComplete.

buscar_pelo_filtro_tabela_auxiliar

GET/tabela_auxiliar/filtro Exige credencial

Busca valores auxiliares por filtro

Exige sessão. Até 50 por página (pagina, a partir de 1, padrão 1). tabela e campo são exatos; label procura o trecho.

function buscar_pelo_filtro_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarPeloFiltroTabelaAuxiliar = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<Array<tipos.TabelaAuxiliar>>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_filtro_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_filtro_tabela_auxiliar(credencial_de_acesso, { tabela: "..." });

Argumentos

Nome

Tipo

Retorno: Promise<Array<tipos.TabelaAuxiliar>> · Rust: Result<Vec<tipos::TabelaAuxiliar>, ErroAoChamarServico>

buscar_pelo_id_tabela_auxiliar

GET/tabela_auxiliar/{id} Exige credencial

Busca um valor auxiliar pelo id

Exige sessão. Registro excluído não é encontrado.

function buscar_pelo_id_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.TabelaAuxiliar>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_pelo_id_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await buscar_pelo_id_tabela_auxiliar(credencial_de_acesso, id);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.TabelaAuxiliar> · Rust: Result<tipos::TabelaAuxiliar, ErroAoChamarServico> · veja TabelaAuxiliar.

atualizar_pelo_id_tabela_auxiliar

PATCH/tabela_auxiliar/{id} Exige credencial

Atualiza o label de um valor auxiliar

Exige o módulo Configuracoes (editar). Muda só o label; campo ausente mantém o valor atual.

function atualizar_pelo_id_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  corpo_da_requisicao: tipos.TabelaAuxiliarAtualizar,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.TabelaAuxiliar>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { atualizar_pelo_id_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
const resposta = await atualizar_pelo_id_tabela_auxiliar(credencial_de_acesso, id, corpo_da_requisicao);

Argumentos

Nome

Tipo

Retorno: Promise<tipos.TabelaAuxiliar> · Rust: Result<tipos::TabelaAuxiliar, ErroAoChamarServico> · veja TabelaAuxiliar.

deletar_pelo_id_tabela_auxiliar

DELETE/tabela_auxiliar/{id} Exige credencial

Exclui um valor auxiliar

Exige o módulo Configuracoes (excluir). A exclusão é lógica: o registro some das leituras, mas a linha não é apagada.

function deletar_pelo_id_tabela_auxiliar(
  credencial_de_acesso: CredencialDeAcesso,
  id: string,
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<void>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { deletar_pelo_id_tabela_auxiliar } from "termo_core/portal";

const credencial_de_acesso = CredencialDeAcesso.token_do_usuario_logado(token_do_usuario);
await deletar_pelo_id_tabela_auxiliar(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.

PaginaTabelaAuxiliar

import type { PaginaTabelaAuxiliar } from "termo_core/portal";

export interface PaginaTabelaAuxiliar {
  itens: Array<PaginaTabelaAuxiliarItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaTabelaAuxiliarAutoComplete

import type { PaginaTabelaAuxiliarAutoComplete } from "termo_core/portal";

export interface PaginaTabelaAuxiliarAutoComplete {
  itens: Array<PaginaTabelaAuxiliarAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaTabelaAuxiliarAutoCompleteItensItem

import type { PaginaTabelaAuxiliarAutoCompleteItensItem } from "termo_core/portal";

export interface PaginaTabelaAuxiliarAutoCompleteItensItem {
  id: string;
  label: string;
}

PaginaTabelaAuxiliarItensItem

import type { PaginaTabelaAuxiliarItensItem } from "termo_core/portal";

export interface PaginaTabelaAuxiliarItensItem {
  atualizado_em: string;
  campo: string;
  criado_em: string;
  id: string;
  label: string;
  tabela: string;
}

TabelaAuxiliar

import type { TabelaAuxiliar } from "termo_core/portal";

export interface TabelaAuxiliar {
  atualizado_em: string;
  campo: string;
  criado_em: string;
  id: string;
  label: string;
  tabela: string;
}

TabelaAuxiliarAtualizar

import type { TabelaAuxiliarAtualizar } from "termo_core/portal";

export interface TabelaAuxiliarAtualizar {
  label?: string | null;
}

TabelaAuxiliarCriar

import type { TabelaAuxiliarCriar } from "termo_core/portal";

export interface TabelaAuxiliarCriar {
  campo: string;
  label: string;
  tabela: string;
}

Rastreamento

7 funções do TermoPortal para rastreamento.

Unidade

7 funções do TermoPortal para unidade.

Nesta página

buscar_paginador_tabela_auxiliarcriar_tabela_auxiliarbuscar_auto_complete_tabela_auxiliarbuscar_pelo_filtro_tabela_auxiliarbuscar_pelo_id_tabela_auxiliaratualizar_pelo_id_tabela_auxiliardeletar_pelo_id_tabela_auxiliarTiposPaginaTabelaAuxiliarPaginaTabelaAuxiliarAutoCompletePaginaTabelaAuxiliarAutoCompleteItensItemPaginaTabelaAuxiliarItensItemTabelaAuxiliarTabelaAuxiliarAtualizarTabelaAuxiliarCriar