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=startdatensatz&_limit=anzahl-datensätze

Format 3 (gibt einen sortierten Datensatzbereich zurück):
/fmi/data/version/databases/datenbankname/layouts/layoutname/records?_offset=startdatensatz&_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=startdatensatz &_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 startdatensatz 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 Ausschnitte:

  • Der portal-Teil der URL ist optional. Wenn portal (Ausschnitt) ausgelassen wird und das Layout Ausschnitte enthält, gibt der Aufruf zugehörige Datensätze aus allen Ausschnitten im Layout zurück. Um also eine bessere Leistung bei Layouts mit Ausschnitten zu erzielen, verwenden Sie portal, um nur die Ausschnitte anzugeben, aus denen Sie zugehörige Datensätze abrufen möchten.

  • Es werden nur die zugehörigen Datensätze zurückgegeben, die in einem Ausschnitt angezeigt werden können. Im Dialogfeld „Ausschnitteinstellung“ in FileMaker Pro können diese Optionen beeinflussen, welche Datensätze zurückgegeben werden können:

    • Vertikales Scrollen zulassen – Wenn diese Option ausgewählt ist, werden alle Datensätze zurückgegeben, die in den sichtbaren Bereich gescrollt werden können. Wenn die Auswahl aufgehoben wird, wird nur die Anzahl der Datensätze zwischen Anfangszeile und Anzahl der Zeilen (die ohne Scrollen sichtbar sind) zurückgegeben.

    • Ausschnittdatensätze filtern – Wenn diese Option ausgewählt ist, werden nur die gefilterten Datensätze zurückgegeben.

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

  • Für _offset.ausschnittname-n ist der startdatensatz die Nummer des ersten Ausschnittdatensatzes im Bereich der Bezugsdatensätze. Wenn nicht angegeben, ist der Standardwert 1.

  • Für _limit.ausschnittname-n gibt anzahl-datensätze die maximale Anzahl an Bezugsdatensätzen an, die zurückgegeben werden dürfen. Wenn nicht angegeben, ist der Standardwert 50.

Weitere optionale URL-Parameter:

  • layout.response – Gibt die Antwortdaten im Kontext eines anderen Layouts zurück. Das angegebene Layout sollte für dieselbe Basistabelle gelten wie das aktuelle Layout. Die Angabe eines Layouts für eine andere Basistabelle kann zu unerwarteten Ergebnissen führen.

  • dateformats – Gibt das Format von Datums- und Zeitstempelfeldern an. Der Wert ist 0 für US-Formate, 1 für die Formate des Dateisystems oder 2 für ISO 8601-Formate. Wenn nicht angegeben, ist der Standardwert 0.

  • script.prerequest, script.presort, script – Führt FileMaker-Scripts als Teil der Anforderung aus. Siehe Ausführen eines Scripts mit einer anderen Anforderung.

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 Sortierfolge (_sort), 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-n und _limit.ausschnittname-n an.

  • Wenn Sie die Werte _offset und _limit 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" }]