Visão geralServiçosEventosRecursos
TermoPortal

Catálogo atributo

7 funções do TermoPortal para catálogo atributo.

// 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_catalogo_atributoGET /catalogo_atributoLista os atributos do catálogo paginados
criar_catalogo_atributoPOST /catalogo_atributoCadastra um atributo do catálogo
buscar_auto_complete_catalogo_atributoGET /catalogo_atributo/autocompleteLista básica de atributos do catálogo para seleção
buscar_pelo_filtro_catalogo_atributoGET /catalogo_atributo/filtroBusca atributos do catálogo por filtro
buscar_pelo_id_catalogo_atributoGET /catalogo_atributo/{id}Busca um atributo do catálogo pelo id
atualizar_pelo_id_catalogo_atributoPATCH /catalogo_atributo/{id}Atualiza um atributo do catálogo
deletar_pelo_id_catalogo_atributoDELETE /catalogo_atributo/{id}Exclui um atributo do catálogo

buscar_paginador_catalogo_atributo

GET/catalogo_atributo Exige credencial

Lista os atributos do catálogo paginados

Exige só uma sessão válida (qualquer pessoa logada no portal). Ordem: tipo, ordem, valor; tipo opcional filtra. Paginado com 50 itens por página (fixo); pagina começa em 1 (padrão 1). A resposta traz itens, total (registros que casam), pagina e tamanho.

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

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

Argumentos

Nome

Tipo

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

criar_catalogo_atributo

POST/catalogo_atributo Exige credencial

Cadastra um atributo do catálogo

Exige a permissão criar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Valor de atributo usado nas variações de produto (ex.: tipo cor valor Azul). tipo tem só letras minúsculas sem acento e _ (até 40); valor é obrigatório, até 120 caracteres e único dentro do tipo; cor_hexadecimal (#RRGGBB) só vale para o tipo cor; ordem não negativa; ativo tem padrão true.

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

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

Argumentos

Nome

Tipo

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

buscar_auto_complete_catalogo_atributo

GET/catalogo_atributo/autocomplete Exige credencial

Lista básica de atributos do catálogo para seleção

Exige só uma sessão válida (qualquer pessoa logada no portal). Devolve só id e valor, em ordem alfabética. busca procura no valor; tipo e ativo filtram. 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_catalogo_atributo(
  credencial_de_acesso: CredencialDeAcesso,
  parametros: ParametrosDeBuscarAutoCompleteCatalogoAtributo = {},
  opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.PaginaCatalogoAtributoAutoComplete>
Exemplo
import { CredencialDeAcesso } from "termo_core";
import { buscar_auto_complete_catalogo_atributo } from "termo_core/portal";

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

Argumentos

Nome

Tipo

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

buscar_pelo_filtro_catalogo_atributo

GET/catalogo_atributo/filtro Exige credencial

Busca atributos do catálogo por filtro

Exige só uma sessão válida (qualquer pessoa logada no portal). Devolve os atributos não excluídos que casam com o filtro, até 50 por página (pagina, a partir de 1, padrão 1), ordenados por tipo, ordem e valor. tipo é exato; valor procura o trecho; ativo filtra pela situação.

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

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

Argumentos

Nome

Tipo

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

buscar_pelo_id_catalogo_atributo

GET/catalogo_atributo/{id} Exige credencial

Busca um atributo do catálogo pelo id

Exige só uma sessão válida (qualquer pessoa logada no portal). Atributo excluído não é encontrado.

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

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

Argumentos

Nome

Tipo

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

atualizar_pelo_id_catalogo_atributo

PATCH/catalogo_atributo/{id} Exige credencial

Atualiza um atributo do catálogo

Exige a permissão editar no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). Muda valor, cor_hexadecimal (envie null para apagar), ordem e ativo; o tipo não muda. Atualização parcial: campo ausente mantém o valor atual.

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

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

Argumentos

Nome

Tipo

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

deletar_pelo_id_catalogo_atributo

DELETE/catalogo_atributo/{id} Exige credencial

Exclui um atributo do catálogo

Exige a permissão excluir no módulo Configuracoes do perfil de quem chama (administrador e master têm tudo). A exclusão é lógica: o registro some das leituras, mas a linha não é apagada.

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

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

CatalogoAtributo

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

export interface CatalogoAtributo {
  ativo: boolean;
  atualizado_em: string;
  cor_hexadecimal?: string | null;
  criado_em: string;
  id: string;
  ordem: number;
  tipo: string;
  valor: string;
}

CatalogoAtributoAtualizar

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

export interface CatalogoAtributoAtualizar {
  ativo?: boolean | null;
  cor_hexadecimal?: string | null;
  ordem?: number | null;
  valor?: string | null;
}

CatalogoAtributoCriar

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

export interface CatalogoAtributoCriar {
  ativo?: boolean | null;
  cor_hexadecimal?: string | null;
  ordem?: number | null;
  tipo: string;
  valor: string;
}

PaginaCatalogoAtributo

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

export interface PaginaCatalogoAtributo {
  itens: Array<PaginaCatalogoAtributoItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaCatalogoAtributoAutoComplete

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

export interface PaginaCatalogoAtributoAutoComplete {
  itens: Array<PaginaCatalogoAtributoAutoCompleteItensItem>;
  pagina: number;
  tamanho: number;
  total: number;
}

PaginaCatalogoAtributoAutoCompleteItensItem

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

export interface PaginaCatalogoAtributoAutoCompleteItensItem {
  id: string;
  valor: string;
}

PaginaCatalogoAtributoItensItem

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

export interface PaginaCatalogoAtributoItensItem {
  ativo: boolean;
  atualizado_em: string;
  cor_hexadecimal?: string | null;
  criado_em: string;
  id: string;
  ordem: number;
  tipo: string;
  valor: string;
}

Boletim técnico medida

8 funções do TermoPortal para boletim técnico medida.

Cliente

9 funções do TermoPortal para cliente.

Nesta página

buscar_paginador_catalogo_atributocriar_catalogo_atributobuscar_auto_complete_catalogo_atributobuscar_pelo_filtro_catalogo_atributobuscar_pelo_id_catalogo_atributoatualizar_pelo_id_catalogo_atributodeletar_pelo_id_catalogo_atributoTiposCatalogoAtributoCatalogoAtributoAtualizarCatalogoAtributoCriarPaginaCatalogoAtributoPaginaCatalogoAtributoAutoCompletePaginaCatalogoAtributoAutoCompleteItensItemPaginaCatalogoAtributoItensItem