Eseguire una richiesta di ricerca

Per eseguire una richiesta di ricerca, utilizzare un metodo POST HTTP con endpoint API _find specificando il nome del database, il formato e informazioni aggiuntive per specificare campi e criteri della query, criterio di ordinamento, record iniziale e numero di record. È anche possibile specificare informazioni sui portali per limitare il numero di record correlati restituiti.

Metodo HTTP

POST

URL

/fmi/data/versione/databases/nome-database/layouts/nome-formato/_find

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 – formato da utilizzare come contesto per la richiesta di ricerca

Intestazione HTTP

Content-Type: application/json

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

Una query in formato JSON che specifica campi e criteri di ricerca. È possibile utilizzare parametri facoltativi per specificare richieste di omissione (omit), criterio di ordinamento (sort), record iniziale (offset), numero di record (limit) e portali (portal) 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.

Ad esempio:

Copia 
{
  "query":[
    {"Group": "=Chirurgo"},
    {"Città lavoro" : "Roma", "omit" : "true"}],
  "sort":[
    {"fieldName": "Città lavoro","sortOrder": "ascend"},
    {"fieldName": "Nome", "sortOrder": "ascend"} ]
}

Esempio con parametri offset, limit e portal:

Copia 
{
  "query":[
    {"Group": "=Chirurgo"},
    {"Città lavoro" : "Roma", "omit" : "true"}],
  "portal": ["Portale1","Portale2"],
  "limit": "10",
  "offset": "1",
  "offset.Portale1": "1",
  "limit.Portale1": "5",
  "layout.response": "Medici"
}

Altri parametri opzionali del corpo della richiesta:

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