Claris FileMaker OData API Handbuch

Open Data Protocol (OData) ist eine als Branchenstandard etablierte API-Implementierung, die eine Standardmethode für die Abfrage und Aktualisierung von Daten bietet und REST API-Clients ermöglicht, auf FileMaker-Daten zuzugreifen, die von FileMaker Cloud und FileMaker Server bereitgestellt werden. OData entspricht der Representational State Transfer- (REST-) Architektur und ist somit ein REST API. OData ähnelt Open Database Connectivity (ODBC) und Java Database Connectivity (JDBC), da es Anwendungen Dritter wie Excel eine Standardmethode für den Zugriff auf FileMaker-Daten bietet. Siehe OData 4.01 Protocol (Englisch).

Zusätzlich gibt OData Daten in den Formaten JavaScript Object Notation (JSON) und Atom Syndication Format (Atom) zurück. JSON ist ein Textformat, das häufig zusammen mit REST APIs verwendet wird, da es kompakt ist und ein von Menschen lesbares Format besitzt. Atom ist ein XML-Format, das für die Erstellung und Aktualisierung von Webressourcen verwendet und für Anwendungen unterstützt wird, die XML-strukturierte Daten statt JSON verwenden.

Wichtig   FileMaker OData API erreicht schrittweise die Konformität mit OData 4.01. Die folgenden Funktionen sind bereits konform:

  • Das OData JSON-Format

  • Unterstützung für Varianten mit und ohne Präfix von Kopfzeilen und Einstellungswerten

  • Ablehnung von Abfragen mit inkompatiblen $schemaversion-Systemabfrageoptionen, wenn Core.SchemaVersion-Anmerkungen in $metadata zurückgegeben werden

  • Unterstützung für die Angabe von Systemabfrageoptionen mit oder ohne das Präfix „$“

  • Unterstützung für Abfrageoptionen, die Groß- und Kleinschreibung nicht berücksichtigen, Operatoren und kanonische Funktionsnamen

  • Rückgabe von Bezeichnern, wenn diese in $metadata angegeben sind

Dieses Handbuch setzt voraus, dass Sie vertraut sind mit:

  • der Verwendung von FileMaker Pro, um Datenbanken zu erstellen. Sie sollten sich mit den Grundlagen der Datenbankgestaltung von FileMaker Pro auskennen und die Konzepte von Feldern, Tabellen, Beziehungen und Containerfeldern verstehen. Siehe FileMaker Pro Hilfe.

  • der Verwendung von FileMaker Server bzw. FileMaker Cloud, um Datenbanken bereitzustellen. Sie sollten in der Lage sein, den Host einzurichten, den Zugang zu bereitgestellten Datenbanken zu ermöglichen und bereitgestellte Datenbanken über Admin Console zu überwachen.

    Siehe die FileMaker Cloud- und FileMaker Server-Produktdokumentation in der Produktdokumentation.

  • der Verwendung von REST APIs in serverseitigen Anwendungen bzw. Webdiensten, die POST-, GET-, PATCH- und DELETE-Methoden aufrufen.