開発者向け機能：JSONデータレイアウト：View：ApiDataTypeの指定方法

2026-09-172026-09-17

概要¶

「API」や「サーバスクリプト」でレコードを操作する際、JSON形式フォーマットで各種オプションを指定します。

返却されるレスポンスの各項目の形式を指定します。

設定値	動作
"KeyValues"	返却されるレスポンスの各項目の形式が表示名となります。
指定なし(既定値)	Keyはカラム名、Valueは値(データベース上に登録されている値)

ApiDataType: "KeyValues"

返却されるレスポンスの各項目のKeyの表示形式を指定します。

設定値	Keyの表示形式
"LabelText"	表示名 (既定値)
"ColumnName"	カラム名

ApiColumnKeyDisplayType: "ColumnName"

※ 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。

返却されるレスポンスの各項目のValueの表示形式を指定します。

ApiColumnValueDisplayType: "DisplayValue"

※ 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。

項目単位で、Key・Valueの表示形式を指定します。各項目ごとに、Keyは"KeyDisplayType"、Valueは"ValueDisplayType"で指定します。

keyの表示形式を指定する

KeyDisplayType	keyの表示形式
"LabelText"	表示名(規定値)
"ColumnName"	カラム名

Valueの表示形式を指定する

（例）更新者(Updator)の値の表示形式を表示名にしたいとき

ApiColumnHash: {
    Updator: {
        ValueDisplayType: "DisplayValue"
    }
}

※ 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。

返却される項目を配列形式で指定します。

GridColumns: ["ClassA","ClassB"]

"GridColumns"を指定しない場合は、「テーブルの管理」の「一覧」タブで有効化された項目が取得されます。

次のように記述します。

GridColumns: ["ClassA","ClassA~11,ClassB"]

※ 本プロパティは、ApiDataTypeが"KeyValues"の場合のみ有効になります。

使用するデータベースによって検索結果が異なる場合があります。