Claris FileMaker OData API ガイド

OData (Open Data Protocol) は、標準化された方法を使用してデータのクエリーおよび更新ができるようになる業界標準の API プロトコルです。REST API クライアントが FileMaker Cloud および FileMaker Server で共有されている FileMaker データにアクセスできるようになります。OData は REST (Representational State Transfer) アーキテクチャに準拠する REST API です。OData は Excel などのサードパーティ製アプリケーションで FileMaker データにアクセスするための標準化された方法を提供するという点で ODBC (Open Database Connectivity) や JDBC (Java Database Connectivity) と似ています。OData 4.01 Protocol (英語) を参照してください。

また、OData は JSON (JavaScript Object Notation) および Atom (Atom Syndication Format) のデータを返します。JSON は軽量で人間が読み取れるため、REST API で一般的に使用されるテキスト形式です。Atom は Web リソースの作成および更新に使用する XML 形式で、JSON ではなく XML 構造化データを使用するアプリケーション用にサポートされています。

重要   FileMaker OData API は OData 4.01 の準拠を段階的に達成しています。次の機能が準拠しています:

  • OData JSON 形式

  • ヘッダと設定値の接頭辞付きと接頭辞なしの両方のバリアントをサポート

  • Core.SchemaVersion アノテーションが $metadata で返された場合、互換性のない $schemaversion システムクエリーオプションを含むリクエストを拒否

  • 接頭辞「$」の有無にかかわらずシステムクエリーオプションの指定をサポート

  • 大文字と小文字を区別しないクエリーオプション、演算子、および標準関数名をサポート

  • $Metadata で指定されている場合には識別子を返す

このガイドでは、次の経験があることを想定しています:

  • FileMaker Pro を使用したデータベースの作成。FileMaker Pro データベースの設計の基礎、フィールド、テーブル、リレーションシップ、およびオブジェクトの概念について理解している必要があります。FileMaker Pro ヘルプを参照してください。

  • FileMaker Server または FileMaker Cloud を使用したデータベースの共有。ホストの設定方法、共有データベースへのアクセスを有効にする方法、および Admin Console を使用して共有データベースを監視する方法について理解している必要があります。

    プロダクトドキュメンテーションセンターで FileMaker Cloud および FileMaker Server 製品のマニュアルを参照してください。

  • POST、GET、PATCH、および DELETE メソッドを呼び出すサーバーサイドアプリケーションまたは Web サービスでの REST API の使用。