TRANXACT.AI Ajuda
Plataforma › API publicada

Exposições

Uma decisão, tomada uma única vez, de que uma tela pode sair desta empresa — quais colunas, quais linhas e se algo pode ser gravado de volta. Nada é acessível de fora até que seja publicado aqui, e não existe "publicar tudo".

Onde encontrar

  1. Módulo: Plataforma
  2. Grupo: Conectividade
  3. Seção: API publicada
  4. Tela: Exposições

Endereço no console: /platform/api-exposures

Lista · 11 colunas · 16 campos em seu formulário · 4 deles exigido

O que a lista mostra

Estas são as colunas da lista, na ordem em que são exibidas. Qualquer uma delas pode ser usada para ordenar, filtrar, ocultar ou exportar.

ColunaTipoNome do campo
Publicado comoCódigocode
NomeTextoname
MóduloStatusmodule_key
TelaCódigoresource_key
AcessoStatusaccess_summary
ColunasTextocolumn_summary
Número máximo de linhasNúmeromax_rows
ChavesNúmerogranted_to
Chamadas (30d)Númerocalls_30d
Última chamadaData e horalast_called_at
StatusStatusstatus

O formulário

O que é solicitado aqui quando um registro é criado. Os campos obrigatórios estão marcados; uma opção selecionada de uma lista de configuração é uma que um administrador pode estender sem uma nova autorização.

CampoTipoEscolhasNotas
Publicado como obrigatório Texto O que o mundo exterior chama a isto. É o URL e o nome da ferramenta MCP — deliberadamente separados do nome da tela, para que renomear uma tela aqui nunca interrompa a integração de ninguém.
Nome obrigatório Texto
O que é isso? Texto longo Lido por um desenvolvedor no documento OpenAPI e por um modelo na lista de ferramentas MCP. Vale a pena mencionar: é o único lugar onde se diz que "pedidos" aqui significa ordens de compra.
Módulo obrigatório Texto Em vez de digitar, selecione a opção no seletor do API Studio — a lista é lida diretamente do produto.
Tela obrigatório Texto
Pode ser lido Sim ou não?
Pode ser criado Sim ou não? Uma criação feita através da API passa pelas mesmas regras de validação, numeração e publicação que uma criação digitada na tela.
Pode ser alterado. Sim ou não?
Pode ser excluído Sim ou não?
Colunas Escolha listado, todos, todos_mas listado — somente o que está nomeado abaixo, e nada mais é enviado. tudo — todas as colunas. tudo_menos — tudo, exceto o que está nomeado abaixo.
Nomes das colunas Texto Separados por vírgula. Um nome com erro ortográfico aqui será silenciado; portanto, use o seletor no API Studio, onde você poderá ver o que a tela realmente exibe.
Fileiras que podem viajar Texto O mesmo filtro é exibido em todas as telas de lista: {"col":"status","op":"eq","value":"posted"}. Ele é aplicado no servidor a cada chamada, e um filtro enviado pelo chamador é combinado com um operador AND abaixo dele — nada que o chamador possa enviar amplia o filtro.
Maior número de linhas por chamada Número
Ofereça como uma ferramenta MCP Sim ou não?
O que dizer a uma modelo Texto longo Apenas nos casos em que um modelo precise ser informado de algo que um desenvolvedor não informaria. Se deixado em branco, a descrição acima será utilizada.
Status Escolha rascunho, ativo, suspenso, aposentado Somente uma exposição ativa é alcançável. Um rascunho é uma decisão que alguém ainda está escrevendo.

As regras que se aplicam aqui

Tudo nesta tela obedece às regras da plataforma, e não a regras próprias. Algumas informações importantes que você precisa saber antes de usar:

Ao lado dele em API publicada