FileMaker Cloud 2.18 OData ガイド

FileMaker データベースでの OData の使用について

概要

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

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

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

FileMaker Pro Advanced を使用したデータベースの作成。FileMaker Pro Advanced データベースの設計の基礎、フィールド、テーブル、リレーションシップ、およびオブジェクトの概念について理解している必要があります。FileMaker Pro Advanced ヘルプを参照してください。
FileMaker Cloud を使用したデータベースの共有。FileMaker Cloud の設定方法、共有データベースへのアクセスを有効にする方法、および FileMaker Cloud Admin Console を使用して共有データベースを監視する方法について理解している必要があります。プロダクトドキュメンテーションセンターで FileMaker Cloud のマニュアルを参照してください。
POST、GET、PATCH、および DELETE メソッドを呼び出すサーバーサイドアプリケーションまたは Web サービスでの REST API の使用。

FileMaker データベースで OData を使用する一般的な手順

OData 呼び出しの処理の流れ

API ソリューションの比較

FileMaker プラットフォームでは、共有されている FileMaker データベースのデータにアクセスするために 2 種類の REST API を使用できます。ビジネスの目的および環境に適したソリューションを選択してください。

ソリューション	使用する環境	利点
OData 規格	OData データソースにアクセスできるアプリケーションで作業している FileMaker データに加えて他の OData データソースとの相互アクセスが必要なアプリケーションの開発しているトランザクションサポートが必要 FileMaker Cloud で共有されているデータにアクセスする	サードパーティ製アプリケーションの開発者は、1 つの呼び出しを実装するだけで FileMaker データを含め OData 規格に準拠するすべてのデータソースを操作できます。 OData では、バッチ、トランザクション、メタデータの作成、およびテーブルの削除がサポートされています。 OData はほとんどの場合、ODBC および JDBC と入れ替えることができます。バッチ処理によりプロセス間通信および接続プーリングが減少するため、パフォーマンスが向上します。 FileMaker データを操作するためのレイアウトは必要ありません。データを操作するためにドライバなど追加のソフトウェアをクライアントにインストールする必要はありません。
FileMaker Data API	レイアウトやポータルなどの FileMaker Pro Advanced の機能を使用している FileMaker Server または FileMaker Cloud for AWS で共有されているデータにアクセスする	レイアウトやポータルなどの FileMaker のコンセプトと統合できます。 FileMaker Cloud for AWS および FileMaker Server オンプレミスホストの両方でサポートされています。

OData および FileMaker の用語

OData の用語	FileMaker の用語
entity	レコード
entity set	テーブル
entity container	データベース名や URL などのレコードに限定されないフィールドのグループ
collection of entity containers	フィールドのグループの一覧 (例: データベース名の一覧)
property	フィールド
path segment	URL 内の 2 つのスラッシュ文字の間にある値
raw value	バイナリ値。人間が読み取れるように構造化された JSON または Atom の値ではなくバイト列の状態の値

OData アクセス用のデータベースの準備

OData アクセスの有効化

OData 規格の準拠および機能のサポート

サポートされている OData の機能

サポートされていない OData の機能

OData リファレンス情報

URL およびデータ形式に関する注意点

FileMaker スクリプトおよび OData

FileMaker スクリプトとは、スクリプトステップのセットに名前を付けたものです。頻繁に実行するタスクの自動化や複数のタスクの組み合わせを実行することができます。OData とともに FileMaker スクリプトを使用すると、Web サービスでより多くのタスクや一連のタスクを実行できます。「スクリプトの実行」を参照してください。

メモ

アカウントとアクセス権を使用して Web サービスで実行できるスクリプトのセットを制限します。Web 互換のスクリプトステップのみがスクリプトに含まれることを確認して、Web サービスから使用する必要があるスクリプトのみを利用できるようにします。
アクセス権により制御されるスクリプトステップを組み合わせて実行する際は、そのスクリプトに対する影響を考慮する必要があります。たとえば、スクリプトにレコードを削除するスクリプトステップが含まれ、レコード削除が許可されているアカウントで Web サービスにログインしていない場合、このスクリプトではレコードを削除するスクリプトステップは実行されません。ただし、スクリプト自体の実行は停止しないことがあるため、予期しない結果になる可能性があります。
スクリプトワークスペースで [完全アクセス] アクセス権セットをスクリプトに付与すると、個人ユーザには許可しないタスクをスクリプトで実行できるようになります。たとえば、ユーザのアカウントとアクセス権ではレコードを削除できないようにする一方で、スクリプト内で定義された条件下で特定のレコードを削除するスクリプトの実行を許可することができます。
データをサーバーに保存するまではデータの変更ができないため、データを変更するスクリプトには [レコード/検索条件確定] スクリプトステップを含める必要があります。これには、[切り取り]、[コピー]、[貼り付け] などのスクリプトステップが含まれます。それぞれの単一の処理は [レコード/検索条件確定] スクリプトステップを含むスクリプトに変換してください。Web サービスで実行されるスクリプトを設計する際は、スクリプトの最後に [レコード/検索条件確定] スクリプトステップを含めて変更がすべて保存されるようにします。
Web ユーザが実行する可能性のある各スクリプトを開いて、OData アクセス用にデータベースを共有する場合にスクリプトが適切に実行されることを確認します。上記の説明のとおり、OData でサポートされているスクリプトステップのみがスクリプトで使用されていることを確認します。

OData API 呼び出しの作成

OData 呼び出しのコンポーネント

OData 呼び出しは次のコンポーネントで構成されます。

コンポーネント	説明
HTTP メソッド	OData は次の HTTP メソッドを使用します: POST テーブルの作成、フィールド索引の作成、レコードの作成、およびスクリプトの実行で使用します。 GET データベースの構造およびメタデータ、クエリーオプション、およびデータの要求で使用します。 PATCH レコードの更新、イメージまたは PDF のオブジェクトフィールドを持つレコードの更新、イメージまたは PDF のオブジェクトフィールドを持つレコードのバイナリデータによる更新、およびテーブルへのフィールドの追加で使用します。 DELETE テーブルの削除、索引の削除、テーブルからのフィールドの削除、およびレコードの削除、クエリーオプションで使用します。
HTTP ヘッダ	OData は次のヘッダを使用します: Authorization: すべてのリクエストで次の形式にする必要があります: FileMaker ID トークン (FMID FileMaker_ID_token) FileMaker ホストへの認証された接続の作成を参照してください。 Accept: 応答の形式を示します。指定する場合、次のいずれかの形式にする必要があります: application/json (デフォルト) application/atom+xml (または application/xml) text/html JSON アプリケーションでは、JSON 固有のオプション「`IEEE754Compatible=true`」がサポートされています。このオプションを使用すると、Edm.Int64 および Edm.Decimal 型のフィールドが文字列として返されます。OData 4.0 JSON (英語) を参照してください。形式を指定した場合、値は `$format` クエリーオプションの値で上書きされます。OData 4.0 Protocol (英語) の「Header Accept」を参照してください。 Content-Type: POST および PATCH メソッドのリクエストボディの形式を示します。指定する場合、次のいずれかの形式にする必要があります: application/json (デフォルト) application/atom+xml (または application/xml) multipart/mixed (`$batch` 処理の場合) OData 4.0 Protocol (英語) の「Header Content-Type」を参照してください。 OData-Version: OData プロトコルのバージョンを示します。FileMaker Cloud では OData 4.0 がサポートされています。OData 4.0 Protocol (英語) の「Header OData-Version」を参照してください。 OData-MaxVersion: OData プロトコルの最大バージョンを示します。FileMaker Cloud では OData 4.0 がサポートされています。OData 4.0 Protocol (英語) の「Header OData-MaxVersion」を参照してください。 Prefer: 次の値がサポートされています: odata.continue-on-error odata.maxpagesize return=representation return=minimal OData 4.0 Protocol (英語) の「Header Prefer」を参照してください。
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前例: `/fmi/odata/v4/コンテンツ管理`
JSON および Atom の引数データの例	POST および PATCH メソッドのみ。

FileMaker ホストへの認証された接続の作成

データベースの構造およびメタデータ

共有データベースおよびその構造に関する情報は HTTP GET メソッドを実行することで取得できます。

データベース名の取得

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` 例: `/fmi/odata/v4`

テーブルの一覧の取得

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前例: `/fmi/odata/v4/コンテンツ管理`

メタデータの取得

テーブルのメタデータ情報を要求するには、HTTP GET メソッドを使用します。

データベースのすべてのメタデータの一覧を要求するには、$metadata キーワードをデータベースサービスのルートで使用します。

コンポーネント説明

HTTP メソッド GET

URL

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/$metadata <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前例: `/fmi/odata/v4/コンテンツ管理/$metadata`

https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/$metadata

<ホスト> – FileMaker Cloud ホスト名
<バージョン> – OData のバージョン。常に v4
<データベース名> – 共有データベースの名前

例: /fmi/odata/v4/コンテンツ管理/$metadata

FileMaker 情報

データベースの FileMaker テーブルに関する情報を提供するために、FileMaker 製品バージョン番号などのアノテーション (OData 規格で定義されていない情報) が結果のメタデータに追加されます。

次のアノテーションには論理値が含まれ、該当する場合は true になります。それ以外の場合、論理値は false になります。

AutoGenerated: FileMaker Pro Advanced によりフィールド値が自動的に生成されるかどうか
Index: フィールド値に索引が設定されるかどうか
VersionID: フィールドがタイムスタンプフィールドで、レコードが変更されたときに新しいタイムスタンプ値が生成されるかどうか
Global: フィールドにグローバル値が含まれるかどうか
Calculation: フィールドが計算タイプかどうか
Summary: フィールドが集計タイプかどうか

他のアノテーション:

MaxRepetitions: 繰り返しフィールドに定義された最大繰り返し数を示す整数値。このアノテーションがないフィールドは繰り返しフィールドではありません。
ExternalSecurePath: オブジェクトフィールドのセキュア格納に指定された相対パスを示す文字列
BestRowID: 常に ROWID を含むシステムフィールド。$select=ROWID を指定することで結果セットに明示的に含めることができます。結果セットの値はレコードに Get (レコード ID) 関数を使用した場合と同じです。
RowVersion: 常に ROWMODID を含むシステムフィールド。$select=ROWMODID を指定することで結果セットに明示的に含めることができます。結果セットの値はレコードに Get (レコード編集回数) 関数を使用した場合と同じです。

重要: OData を使用する場合、各テーブルで主キーを定義する必要があります。OData では主キーにユニークな値が必要な、空欄不可のフィールドを使用します。そのため、テーブルにそのようなフィールドが定義されていない場合、主キーとして ROWID システムフィールドが使用されます。ROWID システムフィールドにはレコードの Get (レコード ID) 関数と同じ値が含まれます。

データの変更

OData ではアカウントに割り当てられたアクセス権に基づいてレコードの作成、更新、および削除の処理をサポートします。

レコードの作成

テーブルにレコードを作成するには、POST メソッドを使用します。POST のボディには 1 つのレコードのデータが JSON 形式で含まれている必要があります。

コンポーネント説明

HTTP メソッド POST

URL

コンポーネント	説明
HTTP メソッド	POST
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/連絡先`
引数	JSON の例: `{ "主キー": "Bジョーンズ", "名前" : "ボブ・ジョーンズ", "ゾーン" : 1, "役職" : "南西部営業部長", "会社" : "Example, Inc.", "Web サイト" : "www.example.com" }` Atom の例: <entry xmlns="https://www.w3.org/2005/Atom" xmlns:metadata="https://docs.oasis-open.org/odata/ns/metadata" xmlns:data="https://docs.oasis-open.org/odata/ns/data"> <content type="application/xml"> <metadata:properties> <data:主キー>Bジョーンズ</data:主キー> <data:名前>ボブ・ジョーンズ</data:名前> <data:ゾーン metadata:type="Decimal">1</data:ゾーン> <data:役職>南西部営業部長</data:役職> <data:会社>Example, Inc.</data:会社> <data:Web サイト>www.example.com</data:Web サイト> </metadata:properties> </content> </entry>

https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>

<ホスト> – FileMaker Cloud ホスト名
<バージョン> – OData のバージョン。常に v4
<データベース名> – 共有データベースの名前
<テーブル名> – テーブルの名前

例: /fmi/odata/v4/連絡先管理/連絡先

引数

JSON の例:

{

   "主キー": "Bジョーンズ",

   "名前" : "ボブ・ジョーンズ",

   "ゾーン" : 1,

   "役職" : "南西部営業部長",

   "会社" : "Example, Inc.",

   "Web サイト" : "www.example.com"

 }

Atom の例:
<entry xmlns="https://www.w3.org/2005/Atom" xmlns:metadata="https://docs.oasis-open.org/odata/ns/metadata" xmlns:data="https://docs.oasis-open.org/odata/ns/data"> <content type="application/xml"> <metadata:properties> <data:主キー>Bジョーンズ</data:主キー> <data:名前>ボブ・ジョーンズ</data:名前> <data:ゾーン metadata:type="Decimal">1</data:ゾーン> <data:役職>南西部営業部長</data:役職> <data:会社>Example, Inc.</data:会社> <data:Web サイト>www.example.com</data:Web サイト> </metadata:properties> </content> </entry>

FileMaker 情報

繰り返しフィールドの個々の繰り返しの値を渡すには、繰り返し数を角カッコで囲んで指定します (例: 名前[4])。
JSON 形式の空のデータオブジェクトを含むレコードを作成する場合、null 値を使用できるフィールドが少なくとも 1 つ必要です。
FileMaker グローバルフィールドは読み取り専用のため、OData で更新することはできません。

レコードの削除

コンポーネント	説明
HTTP メソッド	DELETE
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')`

レコードの更新

コンポーネント	説明
HTTP メソッド	PATCH
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値例: `fmi/odata/v4/連絡先管理/連絡先('ALFKI')`
引数	JSON の例: `{ "Web サイト" : "www.example.com" }`

オブジェクトデータの操作

HTTP POST または PATCH メソッドを送信してピクチャまたは PDF ファイルをオブジェクトフィールドに挿入することができます。オブジェクトフィールド内のデータは、フィールドに埋め込むか、ファイル参照で保存するか、または外部に保存されます。

イメージまたは PDF のオブジェクトフィールドを持つレコードの作成

コンポーネント	説明
HTTP メソッド	POST
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/連絡先`
引数	JSON の例: `{ "主キー": "Bジョーンズ", "名" : "ボブ", "姓" : "ジョーンズ", "写真" : "R0lGODlhCQAJAIABAH9/f////yH5BAEAAAEALAAAAAAJAAkAAAIMjI +pC+1wHkSOrbsKADs=" }`

イメージまたは PDF のオブジェクトフィールドを持つレコードのバイナリデータによる更新

コンポーネント	説明
HTTP メソッド	PATCH
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>)/<フィールド名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値 <フィールド名> – オブジェクトフィールドの名前例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')/写真`
引数	`"474946383961090009008001007F7F7FFFFFFF21F90401000001002C00000000090009 0000020C8C8FA90BED701E448EADBB0A003B"`

イメージまたは PDF のオブジェクトフィールドを持つレコードの更新

コンポーネント	説明
HTTP メソッド	PATCH
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')`
引数	JSON の例: `{ "写真" : "R0lGODlhCQAJAIABAH9/f////yH5BAEAAAEALAAAAAAJAAkAAAIMjI+pC+1wHkSOrbsKADs=" }`

データの要求

テーブルのレコードの要求

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/連絡先`

個々のレコードの要求

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')`

個々のフィールド値の要求

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>)/<フィールド名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値 <フィールド名> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')/名前`

個々のフィールドのバイナリ値の要求

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>)/<フィールド名>/$value <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値 <フィールド名> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/連絡先('ALFKI')/名前/$value` 上記のリクエストでは「連絡先」レコードの「名前」フィールドのバイナリ値が返されます。

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名> (<主キーの値>)/<関連テーブル> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <主キーの値> – レコードの固有の識別子の値 <関連テーブル> – 関連テーブルの名前例: `/fmi/odata/v4/連絡先管理/顧客('ALFKI')/購入/製品` 上記のリクエストでは特定の ID を持つ顧客が購入したすべての製品が返されます。

非関連テーブルのクロス結合の要求

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/$crossjoin (<テーブル 1>, <テーブル 2>)?$filter= (<フィルタ式>)&$expand=(<展開式>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル 1>, <テーブル 2> – テーブルの名前 <フィルタ式> – 各レコードを結果に含めるかどうかを判定する条件 <展開式> – `$select` で指定したフィルタ結果に含まれるテーブルおよびフィールドの一覧例: `/fmi/odata/v4/連絡先管理/$crossjoin(製品,売上)?` `$filter=製品/ID eq 売上/製品ID&` `$expand=製品($select=名前,説明),` `売上($select=顧客名,購入日)`

クエリーオプション

OData ではデータをクエリーするさまざまなクエリーオプションがサポートされています。

クエリーオプション $filter

$filter クエリーオプションを使用してレコードをフィルタします。コレクションの各レコードに対して $filter で指定された式が評価され、式の値が true の項目のみが応答に含まれます。

OData では $filter の処理の中で使用されるビルトインの演算子および関数のセットがサポートされています。使用できる演算子およびビルトイン関数に関する情報については、OData 4.0 Protocol (英語) を参照してください。

コンポーネント説明

HTTP メソッド GET

URL

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>?$filter=(<式>) <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <式> – 各レコードを結果に含めるかどうかを判定する条件例: `/fmi/odata/v4/連絡先管理/連絡先?$filter=役職 eq 'マネージャ' or startswith(役職,'管理者')` 上記のリクエストでは GET メソッドと `$filter` システムクエリーオプションを使用して役職が「マネージャ」または「管理者」の「連絡先」を含むレコードを要求します。

https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>?$filter=(<式>)

<ホスト> – FileMaker Cloud ホスト名
<バージョン> – OData のバージョン。常に v4
<データベース名> – 共有データベースの名前
<テーブル名> – テーブルの名前
<式> – 各レコードを結果に含めるかどうかを判定する条件

例: /fmi/odata/v4/連絡先管理/連絡先?$filter=役職 eq 'マネージャ' or startswith(役職,'管理者')

上記のリクエストでは GET メソッドと $filter システムクエリーオプションを使用して役職が「マネージャ」または「管理者」の「連絡先」を含むレコードを要求します。

FileMaker 情報

次のビルトイン関数はサポートされていません:
- indexof()
- isof()
- geo.distance()
- geo.length()
- geo.intersects()
- fractionalseconds()
日付、時刻、およびタイムスタンプの書式は ISO 8601 に準拠しています。タイムゾーンオフセットはサーバーのタイムゾーンと相対します。
スペースやアンダースコアなどの特殊文字を含むフィールド名はダブルクオーテーションマークで囲みます。

クエリーオプション $orderby

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>?$orderby=<フィールド名> {asc/desc} <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <フィールド名> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/連絡先?$orderby=会社 desc` 上記のリクエストでは「会社」フィールドを基準に降順で「連絡先」レコードがソートされます。

クエリーオプション $top および $skip

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>{?$top/?$skip}=<数字> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前クエリーオプション {?$top/?$skip} – `$top` クエリーオプションで結果に含めるレコードの数を指定します。`$skip` クエリーオプションで除外する数を指定します。例: `/fmi/odata/v4/連絡先管理/連絡先?$top=2` このリクエストでは「連絡先」テーブルの最初の 2 つのレコードが返されます。 `/fmi/odata/v4/連絡先管理/連絡先?$skip=18` このリクエストでは「連絡先」テーブルの 19 番目以降のレコードが返されます。

クエリーオプション $count

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>?$count=true <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/連絡先?$count=true`

クエリーオプション $select

コンポーネント	説明
HTTP メソッド	GET
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/<テーブル名>?$select=<フィールド 1>, <フィールド 2> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <フィールド 1>, <フィールド 2> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/連絡先?$select=会社,Web サイト` 上記のリクエストでは「連絡先」テーブルのすべてのレコードの「会社」および「Web サイト」のデータが返されます。

スキーマの変更

OData では作成および削除の処理がサポートされているため、アカウントに定義されたアクセス権に基づいてテーブルや索引を作成および削除することができます。

テーブルの作成

新しいテーブルを作成するには、HTTP POST メソッドを使用します。POST のボディにはテーブル名である識別子を含む有効なテーブル表現が 1 つ含まれている必要があります。

コンポーネント説明

HTTP メソッド POST

URL

コンポーネント	説明
HTTP メソッド	POST
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Tables`
引数	JSON の例: `{` `"tableName": "会社",` `"fields": [` `{` `"name": "会社 ID",` `"type": "int",` `"primary": true` `},` `{` `"name": "ユーザ ID",` `"type": "varchar(20)",` `"unique": true,` `"default": "CURRENT_USER"` `},` `{` `"name": "会社名",` `"type": "varchar(100)",` `"nullable": false` `},` `{` `"name": "メモ",` `"type": "varchar(2000)",` `"global": true` `},` `{` `"name": "署名済みの契約",` `"type": "blob",` `"externalSecurePath": "ファイル/連絡先管理/"` `}` `]` `}` Atom の例: `<TableDefinition tableName="会社">` `<FieldDefinition name="会社 ID" type="int" primary="true"/>` `<FieldDefinition name="ユーザ ID"` `type="varchar(20)"unique="true" default="CURRENT_USER"/>` `<FieldDefinition name="会社名" type="varchar(100)" nullable="false"/>` `<FieldDefinition name="メモ" type="varchar(2000) global="true"/>` `</TableDefinition>`

https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables

<ホスト> – FileMaker Cloud ホスト名
<バージョン> – OData のバージョン。常に v4
<データベース名> – 共有データベースの名前

例: /fmi/odata/v4/連絡先管理/FileMaker_Tables

引数

JSON の例:

{ "tableName": "会社", "fields": [ { "name": "会社 ID", "type": "int", "primary": true }, { "name": "ユーザ ID", "type": "varchar(20)", "unique": true, "default": "CURRENT_USER" }, { "name": "会社名", "type": "varchar(100)", "nullable": false }, { "name": "メモ", "type": "varchar(2000)", "global": true }, { "name": "署名済みの契約", "type": "blob", "externalSecurePath": "ファイル/連絡先管理/" } ] }

Atom の例:

<TableDefinition tableName="会社"> <FieldDefinition name="会社 ID" type="int" primary="true"/> <FieldDefinition name="ユーザ ID" type="varchar(20)"unique="true" default="CURRENT_USER"/> <FieldDefinition name="会社名" type="varchar(100)" nullable="false"/> <FieldDefinition name="メモ" type="varchar(2000) global="true"/> </TableDefinition>

FileMaker 情報

FileMaker_Tables はテーブルを作成、変更、および削除するために使用するシステムテーブルです。type 引数の型は NUMERIC、DECIMAL、INT、DATE、TIME、TIMESTAMP、VARCHAR、CHARACTER VARYING、BLOB、VARBINARY、LONGVARBINARY、または BINARY VARYING のいずれかです。
繰り返しの値は型の後のカッコ内に指定します (例: "INT[4]")。テキストフィールドの長さの最大値をカッコで指定できます (例: "VARCHAR(200)")。
フィールド名およびフィールドタイプとともに次のオプション引数を使用できます:
- "primary": true または false。フィールドが主キーかどうかを指定します。デフォルトは false です。
- "unique": true または false。フィールドの値をユニークな値にする必要があるかどうかを指定します。デフォルトは false です。
- "nullable": true または false。フィールドが空欄不可かどうかを指定します。デフォルトは true です。
- "global": true または false。フィールドがグローバルフィールドかどうかを指定します。デフォルトは false です。
- "default": データタイプに適したキーワードを含む文字列。有効なキーワードは USER、USERNAME、CURRENT_USER、CURRENT_DATE、CURDATE、CURRENT_TIME、CURTIME、CURRENT_TIMESTAMP、および CURTIMESTAMP です。
- "externalSecurePath" (オブジェクトフィールドのみ): "externalSecurePath" のセキュアなファイルへの相対パスを含む文字列。基本ディレクトリの「[データベースの場所]/」の部分は除外します。FileMaker Pro Advanced で各 FileMaker データベースがこのように設定されていることを確認してください。FileMaker Pro Advanced ヘルプを参照してください。

テーブルへのフィールドの追加

既存のテーブルに新しいフィールドを作成するには、URL で FileMaker_Tables システムテーブルの後にテーブル名を指定して PATCH リクエストを送信します。PATCH ボディにはテーブルに追加するフィールドの配列を含める必要があります。

フィールドを追加する際にエラーでリクエストが失敗した場合でも、他のフィールドはテーブルに追加されます。

コンポーネント説明

HTTP メソッド PATCH

URL

コンポーネント	説明
HTTP メソッド	PATCH
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Tables/会社` 上記のリクエストでは「会社」テーブルに「電話」という名前のフィールドを作成します。
引数	JSON の例: `{` `"fields": [` `{` `"name": "電話",` `"type": "varchar(25)"` `}` `]` `}` Atom の例: `<TableDefinition tableName="会社">` `<FieldDefinition name="電話" type="varchar(25)"/>` `</TableDefinition>`

https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables/<テーブル名>

例: /fmi/odata/v4/連絡先管理/FileMaker_Tables/会社

上記のリクエストでは「会社」テーブルに「電話」という名前のフィールドを作成します。

引数

JSON の例:

{ "fields": [ { "name": "電話", "type": "varchar(25)" } ] }

Atom の例:

<TableDefinition tableName="会社"> <FieldDefinition name="電話" type="varchar(25)"/> </TableDefinition>

FileMaker 情報

FileMaker_Tables はテーブルを作成、変更、および削除するために使用するシステムテーブルです。有効なオプションについては、「テーブルの作成」を参照してください。

テーブルの削除

コンポーネント	説明
HTTP メソッド	DELETE
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Tables/会社`

テーブルからのフィールドの削除

コンポーネント	説明
HTTP メソッド	DELETE
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Tables/<テーブル名>/<フィールド名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <フィールド名> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Tables/会社/メモ`

フィールド索引の作成

コンポーネント	説明
HTTP メソッド	POST
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Indexes/<テーブル名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Indexes/会社`
引数	JSON の例: `{ "indexName" : "都道府県" }` Atom の例: `<IndexDefinition indexName="都道府県"/>`

索引の削除

コンポーネント	説明
HTTP メソッド	DELETE
URL	https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/FileMaker_Indexes/<テーブル名>/<フィールド名> <ホスト> – FileMaker Cloud ホスト名 <バージョン> – OData のバージョン。常に `v4` <データベース名> – 共有データベースの名前 <テーブル名> – テーブルの名前 <フィールド名> – フィールドの名前例: `/fmi/odata/v4/連絡先管理/FileMaker_Indexes/会社/都道府県`

スクリプトの実行

スクリプトを実行するには、URL で Script システムテーブルの後にスクリプトの名前を指定して POST リクエストを送信します。スクリプトに引数を渡さない場合、POST のボディを完全に空にする必要があります。スクリプトに引数を渡す場合、「scriptParameterValue」という名前のフィールドを 1 つ含める必要があります。「scriptParameterValue」には文字列、数字、および JSON オブジェクト型の値を使用できます。

OData では特殊文字 (例: @、&、/) を含むスクリプト名または数字で始まる名前はサポートされていません。スクリプトに [現在のスクリプト終了] スクリプトステップが含まれる場合、[現在のスクリプト終了] のテキスト結果が結果の「resultParameter」という名前のフィールドに返されます。

「HelloScript」は文字列「Hello」に引数の値を追加して結果を返すスクリプトです。OData では Content-Type が「application/json」の応答のボディで結果が返されます。

 { 

  "scriptResult": 
 
    { 

      "code": 0, 

      "resultParameter": "Hello World" 

    } 

}

メモ: OData ではユーザインタラクションなしで実行されるスクリプトのみがサポートされています。

FileMaker Cloud 2.18 OData ガイド

FileMaker データベースでの OData の使用について

概要

FileMaker データベースで OData を使用する一般的な手順

OData 呼び出しの処理の流れ

API ソリューションの比較

OData および FileMaker の用語

OData アクセス用のデータベースの準備

OData アクセスの有効化

OData 規格の準拠および機能のサポート

サポートされている OData の機能

サポートされていない OData の機能

OData リファレンス情報

URL およびデータ形式に関する注意点

FileMaker スクリプトおよび OData

OData API 呼び出しの作成

OData 呼び出しのコンポーネント

FileMaker ホストへの認証された接続の作成

データベースの構造およびメタデータ

データベース名の取得

テーブルの一覧の取得

メタデータの取得

データの変更

レコードの作成

レコードの削除

レコードの更新

オブジェクトデータの操作

イメージまたは PDF のオブジェクトフィールドを持つレコードの作成

イメージまたは PDF のオブジェクトフィールドを持つレコードのバイナリデータによる更新

イメージまたは PDF のオブジェクトフィールドを持つレコードの更新

データの要求

テーブルのレコードの要求

個々のレコードの要求

個々のフィールド値の要求

個々のフィールドのバイナリ値の要求

関連テーブルの参照

非関連テーブルのクロス結合の要求

クエリーオプション

クエリーオプション $filter

クエリーオプション $orderby

クエリーオプション $top および $skip

クエリーオプション $count

クエリーオプション $select

スキーマの変更

テーブルの作成

テーブルへのフィールドの追加

テーブルの削除

テーブルからのフィールドの削除

フィールド索引の作成

索引の削除

スクリプトの実行

スクリプトの実行

OData の共有、テスト、および監視

OData アクセス用のデータベースの共有

OData アクセスのテスト

OData アクセスの監視

リーガル情報