Ricavare un singolo record

Per ricavare un record, utilizzare un metodo GET HTTP con endpoint API records specificando il nome del database, il formato e l'ID del record. È anche possibile specificare informazioni sui portali per limitare il numero di record correlati restituiti.

Metodo HTTP

GET

URL

Formato 1: /fmi/data/versione/databases/nome-database/layouts/nome-formato/records/id-record

Formato 2: /fmi/data/versione/databases/nome-database/layouts/nome-formato/records/id-record?portal=["nome-portale-n", ...] &_offset.nome-portale=record-iniziale &_limit.nome-portale=numero-di-record

versione – la versione di FileMaker Data API richiesta può utilizzare la v1, v2 o vLatest

  • versione 1 (v1) - la struttura dei dati del portale restituiti è basata sull'impostazione della visualizzazione (Visualizza come modulo o Visualizza come tabella) del formato specificato.

    • Visualizza come modulo - restituisce tutti i record correlati

    • Visualizza come tabella - restituisce il primo record correlato

    Nota  La modifica dell'impostazione della visualizzazione cambia la struttura dei dati del portale per il valore restituito.

  • versione 2 (v2) - la struttura dei dati del portale restituiti è basata su Visualizza come modulo.

  • ultima versione (vLatest) - il comportamento si basa sull'ultima versione dell'API.

nome-database – nome del database ospitato

nome-formato – nome del formato da utilizzare come contesto per ricavare il record

id-record – ID del record da ricavare

Per la parola chiave del portale:

nome-portale-n è un portale contenente i record correlati. Il nome di un portale può essere il nome oggetto visualizzato nella finestra Impostazioni di FileMaker Pro o il nome della tabella correlata. È possibile specificare più nomi del portale.

La parte dell'URL relativa ai portali è facoltativa. Se il formato contiene dei portali, specificarne i nomi per risultati migliori. Se la parte relativa ai portali non viene specificata, la chiamata restituirà tutti i record correlati in tutti i portali nel formato.

Per _offset.nome-portale-n, record-iniziale è il numero del primo record del portale nella serie di record correlati.

Per _limit.nome-portale-n, numero-di-record specifica il numero massimo di record correlati da restituire.

Per i dati di risposta nel contesto di un formato diverso, utilizzare il parametro layout.response nell'URL. Il formato specificato da layout.response deve essere un formato della stessa tabella. Se si specifica un formato di un'altra tabella, potrebbero verificarsi risultati imprevisti.

È possibile eseguire script FileMaker come parte di questa richiesta includendo i parametri script.prerequest, script.presort e script nell'URL. Vedere Esecuzione di script FileMaker.

Intestazione HTTP

Authorization: token-sessione di connessione, dove token-sessione è il valore X-FM-Data-Access-Token univoco per la sessione del database

Parametri Nessuno.
Risposta

I dati del record in formato JSON e una matrice di messaggi con un codice di errore 0.

Ad esempio:

Copia
{
  "response": {
    "data": [ 
    ...  
    ]
  },
  "messages": [{"code":"0","message":"OK"}]
}

Vedere Risposte di errore.

Note 

  • Per restituire i dati di determinate righe del portale, utilizzare _offset.nome-portale e _limit.nome-portale. Il nome di un portale può essere il nome oggetto visualizzato nella finestra Impostazioni di FileMaker Pro o il nome della tabella correlata. Se non si specificano i valori offset e limit per le righe del portale, i valori predefiniti per offset e limit per i record del portale sono rispettivamente 1 e 50.