レイアウトメタデータの取得

レイアウト、ポータル、および値一覧のフィールドを含むレイアウトメタデータを取得するには、layouts API エンドポイントと HTTP GET メソッドを使用してレイアウト名を指定します。

HTTP メソッド

GET

URL

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

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

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

layout-name – メタデータを必要とするレイアウトの名前

形式 2: /fmi/data/version/databases/database-name/layouts/layout-name?recordId=record-id

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

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

layout-name – メタデータを必要とするレイアウトの名前

record-id - 関連する値一覧データを取得するには、recordId クエリー引数を含めます。

HTTP ヘッダ

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

fieldMetaData、portalMetaData および valueLists 配列を含む応答のボディ、およびエラーコード 0 を表示するメッセージ配列。

例:

コピー 
{
  "response": {
    "fieldMetaData": [
      {
        "name": "CustomerName",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "valueList": "Text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "portalMetaData": {},
    "valueLists": [
      {
        "name": "Region",
        "type": "customList",
        "values": [
          {
            "displayValue": "West",
            "value": "West"
          }
          , 
          {
            "displayValue": "East",
            "value": "East"
          }
        ]
      }
    ]
  },
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

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

メモ 

  • 動的な値一覧の場合、リクエストに URL の一部として recordId 引数が含まれないときに空の値一覧を返します。