TRANXACT.AI Aiuto
Piattaforma › API pubblicata

esposizioni

Una decisione, presa una volta per tutte, che stabilisce che uno schermo può lasciare questa azienda: quali colonne, quali righe e se è possibile riscrivervi qualcosa. Nulla è accessibile dall'esterno finché non viene pubblicato qui, e non esiste un "pubblicare tutto".

Dove trovarlo

  1. Modulo: Piattaforma
  2. Gruppo: Connettività
  3. Sezione: API pubblicata
  4. Schermo: esposizioni

Indirizzo nella console: /platform/api-exposures

Lista · 11 colonne · 16 campi sulla sua forma · 4 di loro richiesto

Cosa mostra l'elenco

Queste sono le colonne dell'elenco, nell'ordine in cui vengono visualizzate. Ognuna di esse può essere utilizzata per ordinare, filtrare, nascondere o esportare i dati.

ColonnaTipoNome del campo
Pubblicato comeCodicecode
NomeTestoname
ModuloStatomodule_key
SchermoCodiceresource_key
AccessoStatoaccess_summary
ColonneTestocolumn_summary
Numero massimo di righeNumeromax_rows
ChiaviNumerogranted_to
Chiamate (30 giorni)Numerocalls_30d
Ultima chiamataData e oralast_called_at
StatoStatostatus

Il modulo

Ecco cosa viene richiesto quando si crea un record. I campi obbligatori sono contrassegnati; una scelta tratta da un elenco di configurazione è una di quelle che un amministratore può estendere senza bisogno di una nuova versione.

CampoTipoScelteNote
Pubblicato come necessario Testo È così che il mondo esterno lo chiama. Si tratta dell'URL e del nome dello strumento MCP, volutamente separati dal nome della schermata, in modo che rinominare una schermata qui non comprometta mai l'integrazione di nessuno.
Nome necessario Testo
Che cos'è Testo lungo Letto da uno sviluppatore nel documento OpenAPI e da un modello nell'elenco degli strumenti MCP. Vale la pena sottolinearlo: è l'unico punto in cui viene specificato che "ordini" qui si riferisce agli ordini di acquisto.
Modulo necessario Testo Seleziona gli elementi dallo strumento di selezione in API Studio anziché digitarli: l'elenco viene letto direttamente dal prodotto.
Schermo necessario Testo
Può essere letto sì o no
Può essere creato sì o no La creazione tramite API segue le stesse regole di convalida, numerazione e pubblicazione di una creazione effettuata digitando sullo schermo.
Potrebbe essere modificato sì o no
Potrebbe essere eliminato sì o no
Colonne Scelta elencato, Tutto, tutti tranne elencato — solo ciò che è indicato di seguito, e nient'altro viene mai inviato. tutto — tutte le colonne. tutto_tranne — tutto tranne ciò che è indicato di seguito.
Nomi delle colonne Testo Separati da virgole. Un nome scritto in modo errato qui non viene visualizzato, quindi usa il selettore in API Studio dove puoi vedere cosa c'è effettivamente sullo schermo.
file che possono viaggiare Testo Lo stesso filtro viene visualizzato in ogni schermata dell'elenco: {"col":"status","op":"eq","value":"posted"}. Viene applicato sul server ad ogni chiamata e un filtro inviato dal chiamante viene combinato con un'operazione AND al di sotto di esso: nulla di ciò che possono inviare lo amplia.
Numero massimo di righe per chiamata Numero
Offerto come strumento MCP sì o no
Cosa dire a una modella Testo lungo Solo quando un modello ha bisogno di informazioni che uno sviluppatore non richiederebbe. Se lasciato vuoto, viene utilizzata la descrizione sopra riportata.
Stato Scelta bozza, attivo, sospeso, pensionato È raggiungibile solo un'esposizione attiva. Una bozza è una decisione che qualcuno sta ancora scrivendo.

Le regole che si applicano qui

Tutto ciò che appare su questa schermata obbedisce alle regole della piattaforma, non a regole proprie. Ecco quelle che è bene conoscere prima di utilizzarla:

Accanto ad esso in API pubblicata