単一のレコードの取得

レコードを取得するには、HTTP GET メソッドを使用してデータベース名、レイアウト、およびレコード ID を records API エンドポイントで指定します。ポータル情報を指定して返される関連レコードの数を制限することもできます。

HTTP メソッド

GET

URL

形式 1: /fmi/data/version/databases/database-name/layouts/layout-name/records/record-id

形式 2: /fmi/data/version/databases/database-name/layouts/layout-name/records/record-id?portal=["portal-name-n", ...] &_offset.portal-name=starting-record &_limit.portal-name=number-of-records

version – リクエストされた FileMaker Data API のバージョン。v1、v2、または vLatest のいずれかを使用できます。

  • バージョン 1 (v1) - 返されるポータルデータの構造は指定されたレイアウトの表示形式 (フォーム形式または表形式) に基づきます。

    • フォーム形式 - すべての関連レコードを返します

    • 表形式 - 最初の関連レコードを返します

    メモ  表示設定を変更すると返される値のポータルデータ構造が変化します。

  • バージョン 2 (v2) - 返されるポータルデータの構造はフォーム形式に基づきます。

  • 最新バージョン (vLatest) - 動作は API の最新バージョンに基づきます。

database-name – 共有データベースの名前

layout-name – レコード取得のためのコンテキストとして使用するレイアウトの名前

record-id – 取得するレコードのレコード ID

portal キーワードについて:

portal-name-n は関連レコードが含まれているポータルです。FileMaker Pro のインスペクタに表示されるオブジェクト名か、関連テーブル名のいずれかをポータル名にすることができます。複数のポータル名を指定することができます。

URL の portal 部分はオプションです。レイアウトに複数のポータルが含まれている場合は、パフォーマンスを向上させるためにポータル名を指定します。portal 部分を省略した場合、呼び出しによってレイアウト上のすべてのポータルにあるすべての関連レコードが返されます。

_offset.portal-name-n の場合、starting-record は関連レコードの範囲内で最初のポータルレコードのレコード番号です。

_limit.portal-name-n の場合、返される関連レコードの最大数を number-of-records で指定します。

異なるレイアウトのコンテキストにある応答データが必要な場合は、URL 内の layout.response 引数を使用します。layout.response で指定されているレイアウトは同じテーブルのレイアウトにする必要があります。異なるテーブルのレイアウトを指定すると予期しない結果になる可能性があります。

URL に script.prerequest、script.presort、および script 引数を含めることで、FileMaker スクリプトをこのリクエストの一部として実行することができます。「FileMaker スクリプトの実行」を参照してください。

HTTP ヘッダ

Authorization: Bearer session-token。session-token はデータベースセッションに固有の X-FM-Data-Access-Token の値です。
引数 なし
応答

JSON 形式のレコードデータおよびエラーコード 0 を表示するメッセージ配列。

例:

コピー 
{
  "response": {
    "data": [ 
    ...  
    ]
  },
  "messages": [{"code":"0","message":"OK"}]
}

「エラー応答」を参照してください。

メモ 

  • 特定のポータル行にデータを返すには、_offset.portal-name および _limit.portal-name を使用します。FileMaker Pro のインスペクタに表示されるオブジェクト名か、関連テーブル名のいずれかをポータル名にすることができます。ポータル行のオフセット値と制限値を省略した場合、デフォルトのオフセット値 1 とポータルレコードのデフォルトの制限値 50 が使用されます。