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 i portali:

  • La parte portale dell'URL è facoltativa. Se portale viene omesso e il formato include portali, la chiamata restituirà i record correlati di tutti i portali presenti nel formato. Quindi, per prestazioni migliori sui formati con portali, utilizzare portale per specificare solo i portali da cui occorre ottenere i record correlati.

  • Verranno restituiti solo i record correlati che possono essere visualizzati in un portale. Nella finestra di dialogo Impostazione portale di FileMaker Pro, queste opzioni possono influire su quali record possono essere restituiti:

    • Consenti scorrimento verticale - se selezionato, vengono restituiti tutti i record che possono essere fatti scorrere per consentire la visualizzazione. Se deselezionato, viene restituito solo il numero di record tra Riga iniziale e Numero di righe (quelli visibili senza scorrere).

    • Filtra i record del portale - se selezionato, vengono restituiti solo i record filtrati.

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

  • Per _offset.nome-portale-n, record-iniziale è il numero del primo record del portale nella serie di record correlati. Se non specificato, il valore predefinito è 1.

  • Per _limit.nome-portale-n, numero-di-record specifica il numero massimo di record correlati da restituire. Se non specificato, il valore predefinito è 50.

Altri parametri URL opzionali:

  • layout.response - restituisce i dati di risposta nel contesto di un formato diverso. Il formato specificato dovrebbe essere per la stessa tabella di base del formato corrente. Se si specifica un formato di un'altra tabella di base, potrebbero verificarsi risultati imprevisti.

  • dateformats - specifica il formato dei campi Data e Indicatore data e ora. Il valore è 0 per i formati statunitensi, 1 per i formati delle impostazioni locali del file o 2 per i formati ISO 8601. Se non specificato, il valore predefinito è 0.

  • script.prerequest, script.presort, script - esegue gli script FileMaker come parte della richiesta. Vedere Esecuzione di uno script con un'altra richiesta.

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 (_sort), 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-n e _limit.nome-portale-n.

  • 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" }]