Ricavare una serie di record

Per ricavare una serie di record, utilizzare un metodo GET HTTP con endpoint API records specificando il nome del database, il formato e informazioni aggiuntive per specificare un record iniziale e il numero di record. Se lo si desidera, è possibile specificare il criterio di ordinamento dei record. È anche possibile specificare informazioni sui portali per limitare il numero di record correlati restituiti.

Metodo HTTP

GET

URL

Formato 1 (restituisce fino ai primi 100 record):
/fmi/data/versione/databases/nome-database/layouts/nome-formato/records

Formato 2 (restituisce una serie di record):
/fmi/data/versione/databases/nome-database/layouts/nome-formato/records?_offset=record-iniziale&_limit=numero-di-record

Formato 3 (restituisce una serie ordinata di record):
/fmi/data/versione/databases/nome-database/layouts/nome-formato/records?_offset=record-iniziale&_limit=numero-di-record&_sort=[{ "fieldName": "nome-campo", "sortOrder": "criterio-ordinamento" }, { ... }]

Formato 4 (include una serie di record con una serie limitata di record correlati):
/fmi/data/versione/databases/nome-database/layouts/nome-formato/records?_offset=record-iniziale&_limit=numero-di-record&portal=["nome-portale1", "nome-portale2", ...]&_offset.nome-portale1=record-iniziale&_limit.nome-portale1=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

Per _offset, record-iniziale è il numero del primo record nella serie di record.

Per _limit, numero-di-record specifica il numero massimo di record da restituire.

Per _sort, l'informazione deve essere specificata in formato JSON. nome-campo è il nome di un campo da utilizzare come base per l'ordinamento dei record. È possibile specificare più nomi di campo. Per criterio-ordinamento, specificare la parola chiave ascend o descend oppure specificare il nome di una lista valori.

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, si potrebbero voler specificare 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.

È 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.

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

Vedere Risposte di errore.

Note 

  • È possibile utilizzare parametri facoltativi per specificare richieste di omissione, criterio di ordinamento, record iniziale (offset), numero di record (limit) e portali per limitare il numero di record correlati restituiti. I parametri offset, limit e sort agiscono sui record trovati nella tabella del formato e non sui record del portale correlati. Per limitare il numero di record e righe da visualizzare in un gruppo correlato, specificare i parametri offset.nome-portale e limit.nome-portale.

  • Se non si specificano i valori offset e limit, i valori predefiniti per offset e limit per i record sono rispettivamente 1 e 100: _offset=1&_limit=100

  • Se non si specifica la parola chiave sortOrder, il valore predefinito è ascend. Ad esempio, &_sort=[{ "fieldName": "idRecord" }] viene trattato come: &_sort=[{ "fieldName": "idRecord", "sortOrder": "ascend" }]

  • 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. Il nome di un portale può essere il nome oggetto visualizzato nella finestra Impostazioni di FileMaker Pro o il nome della tabella correlata.