メタデータの取得
テーブルのメタデータ情報を要求するには、HTTP GET メソッドを使用します。
データベースのすべてのメタデータの一覧を要求するには、$metadata キーワードをデータベースサービスのルートで使用します。
| コンポーネント | 説明 |
|---|---|
|
HTTP メソッド |
GET |
|
URL |
https://<ホスト>/fmi/odata/<バージョン>/<データベース名>/$metadata <ホスト> – FileMaker Cloud または FileMaker Server のホスト名 <バージョン> – OData のバージョン。常に <データベース名> – 共有データベースの名前 例: |
FileMaker 情報
データベースの FileMaker テーブルに関する情報を提供するために、FileMaker 製品バージョン番号などのアノテーション (OData 規格で定義されていない情報) が結果のメタデータに追加されます。
次のアノテーションには論理値が含まれ、該当する場合は true になります。それ以外の場合、論理値は false になります。
-
AutoGenerated: FileMaker Pro によりフィールド値が自動的に生成されるかどうか
-
Index: フィールド値に索引が設定されるかどうか
-
VersionID: フィールドがタイムスタンプフィールドで、レコードが変更されたときに新しいタイムスタンプ値が生成されるかどうか
-
Global: フィールドにグローバル値が含まれるかどうか
-
Calculation: フィールドが計算タイプかどうか
-
Summary: フィールドが集計タイプかどうか
他のアノテーション:
-
MaxRepetitions: 繰り返しフィールドに定義された最大繰り返し数を示す整数値。このアノテーションがないフィールドは繰り返しフィールドではありません。
-
ExternalSecurePath: オブジェクトフィールドのセキュア格納に指定された相対パスを示す文字列
-
BestRowID: 常に ROWID を含むシステムフィールド。
$select=ROWIDを指定することで結果セットに明示的に含めることができます。結果セットの値はレコードに Get (レコード ID) 関数を使用した場合と同じです。 -
RowVersion: 常に ROWMODID を含むシステムフィールド。
$select=ROWMODIDを指定することで結果セットに明示的に含めることができます。結果セットの値はレコードに Get (レコード編集回数) 関数を使用した場合と同じです。
重要 OData を使用する場合、各テーブルで主キーを定義する必要があります。OData では主キーに固有の値が必要な、空欄不可のフィールドを使用します。そのため、テーブルにそのようなフィールドが定義されていない場合、主キーとして ROWID システムフィールドが使用されます。ROWID システムフィールドにはレコードの Get (レコード ID) 関数と同じ値が含まれます。