Abrufen eines Datensatzbereichs

Um einen Bereich von Datensätzen abzurufen, verwenden Sie eine HTTP GET-Methode, wobei der API-Endpunkt records den Datenbanknamen, das Layout und weitere Informationen enthält, um einen Startdatensatz und die Anzahl der Datensätze anzugeben. Optional können Sie die Sortierfolge der Datensätze angeben. Sie können zudem Ausschnittinformationen angeben, um die Anzahl der zurückgegebenen Bezugsdatensätze zu begrenzen.

HTTP-Methode

GET

URL

Format 1 (gibt maximal die ersten 100 Datensätze zurück):
/fmi/data/version/databases/datenbankname/layouts/layoutname/records

Format 2 (gibt einen Datensatzbereich zurück):
/fmi/data/version/databases/datenbankname/layouts/layoutname/records?_offset=start-datensatz&_limit=anzahl-datensätze

Format 3 (gibt einen sortierten Datensatzbereich zurück):
/fmi/data/version/databases/datenbankname/layouts/layoutname/records?_offset=start-datensatz&_limit=anzahl-datensätze&_sort=[{ "fieldName": "feldname", "sortOrder": "sortierfolge" }, { ... }]

Format 4 (umfasst einen Datensatzbereich mit einem begrenzten Bereich an Bezugsdatensätzen):
/fmi/data/version/databases/datenbankname/layouts/layoutname/records?_offset=startdatensatz&_limit=anzahl-datensätze&portal=["ausschnittname1", "ausschnittname2", ...]&_offset.ausschnittname1=start-datensatz&_limit.ausschnittname1=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

Für _offset ist der start-datensatz die Datensatznummer des ersten Datensatzes im Datensatzbereich.

Für _limit gibt anzahl-datensätze die maximale Anzahl an Datensätzen an, die zurückgegeben werden können.

Die Angabe _sort muss in JSON-Format erfolgen. feldname ist der Name eines Felds, das als Basis für die Sortierung der Datensätze verwendet wird. Sie können mehrere Feldnamen angeben. Geben Sie für sortierfolge das Schlüsselwort ascend oder descend oder einen Wertelistennamen an.

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.

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.

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

Siehe Fehlerantworten.

Hinweise 

  • Sie können optionale Parameter verwenden, um Ausschlussabfragen, die Sortierreihenfolge, den Anfangsdatensatz (offset), die Anzahl der Datensätze (limit) und die Ausschnitte zur Begrenzung der Anzahl der zurückgegebenen Bezugsdatensätze anzugeben. Die Parameter „offset“, „limit“ und „sort“ wirken auf Datensätze, die sich in der Tabelle des Layouts befinden, und nicht auf Bezugsausschnitts-Datensätze. Um die Anzahl der Datensätze und der anzuzeigenden Zeilen in einer Bezugsmenge zu begrenzen, geben Sie die Parameter offset.ausschnittname und limit.ausschnittname an.

  • Wenn Sie die Versatz- und Limit-Werte weglassen, ist der Standard für Versatz 1 und für Limit 100: _offset=1&_limit=100

  • Wenn Sie das Schlüsselwort „sortOrder“ weglassen, ist der Standard ascend. Beispiel: &_sort=[{ "fieldName": "recordId" }] wird identisch behandelt wie: &_sort=[{ "fieldName": "recordId", "sortOrder": "ascend" }]

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