Abrufen eines einzelnen Datensatzes

Um einen Datensatz abzurufen, verwenden Sie eine HTTP GET-Methode mit API-Endpunkt records, der Datenbankname, Layout und DatensatzID angibt. Sie können zudem Ausschnittinformationen angeben, um die Anzahl der zurückgegebenen Bezugsdatensätze zu begrenzen.

HTTP-Methode

GET

URL

Format 1: /fmi/data/version/databases/datenbankname/layouts/layoutname/records/datensatzid

Format 2: /fmi/data/version/databases/datenbankname/layouts/layoutname/records/datensatzid?portal=["ausschnittname-n", ...] &_offset.ausschnittname=start-datensatz &_limit.ausschnittname=anzahl-datensätze

version – die angeforderte FileMaker Data API-Version, kann v1, v2 oder vLatest sein

  • version 1 (v1) - die Struktur für zurückgegebene Ausschnittdaten basiert auf der Ansichtseinstellung (Formularansicht oder Tabellenansicht) des angegebenen Layouts.

    • Formularansicht – gibt alle Bezugsdatensätze zurück

    • Tabellenansicht – gibt den ersten Bezugsdatensatz zurück

    Hinweis  Durch die Änderung der Ansichtseinstellung wird die Ausschnittdatenstruktur für den zurückgegebenen Wert geändert.

  • version 2 (v2) – die Struktur für zurückgegebene Ausschnittdaten basiert auf der Formularansicht.

  • letzte Version (vLatest) – das Verhalten basiert auf der letzten Version des API.

datenbankname – der Name der bereitgestellten Datenbank

layoutname – der Name des Layouts, das als Kontext für das Abrufen des Datensatzes dienen soll

datensatzid – die DatensatzID des Datensatzes, der abgerufen werden soll

Für das Schlüsselwort „portal“:

ausschnittname-n ist ein Ausschnitt, der Bezugsdatensätze enthält. Ein Ausschnittname kann entweder der im Inspektor in FileMaker Pro angegebene Objektname oder der Name der Bezugstabelle sein. Sie können mehrere Ausschnittnamen angeben.

Der Ausschnittteil der URL ist optional. Wenn das Layout Ausschnitte umfasst, geben Sie die Ausschnittnamen an, um die Leistung zu optimieren. Wenn der Ausschnittteil weggelassen wird, gibt der Aufruf alle Bezugsdatensätze in allen Ausschnitten im Layout zurück.

Für _offset.ausschnittname-n ist der start-datensatz die Nummer des ersten Ausschnittdatensatzes im Bereich der Bezugsdatensätze.

Für _limit.ausschnittname-n gibt anzahl-datensätze die maximale Anzahl an Bezugsdatensätzen an, die zurückgegeben werden dürfen.

Wenn Sie die Antwortdaten im Kontext eines anderen Layouts wünschen, verwenden Sie den Parameter layout.response in der URL. Das durch layout.response angegebene Layout muss ein Layout für die gleiche Tabelle sein. Die Angabe eines Layouts für eine andere Tabelle kann zu unerwarteten Ergebnissen führen.

Sie können FileMaker-Scripts als Teil dieser Abfrage ausführen, indem Sie die Parameter script.prerequest, script.presort und script in der URL angeben. Siehe FileMaker-Scripts ausführen.

HTTP-Header

Authorization: session-token des Inhabers, wobei session-token den eindeutigen Wert des X-FM-Data-Access-Token für die Datenbanksitzung darstellt
Parameter Keine
Antwort

Die Datensatzdaten in JSON-Format und ein Meldungsarray, das den Fehlercode 0 zeigt.

Beispiel:

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

Siehe Fehlerantworten.

Hinweise 

  • Um Daten für bestimmte Ausschnittzeilen zurückzugeben, verwenden Sie _offset.ausschnittname und _limit.ausschnittname. Ein Ausschnittname kann entweder der im Inspektor in FileMaker Pro angegebene Objektname oder der Name der Bezugstabelle sein. Wenn Sie die Versatz- und Limit-Werte für Ausschnittzeilen weglassen, ist der Standard für Versatz 1 und für Limit 50.