フォームのレイアウトを取得する
フォームのレイアウトを取得します。
次の設定を取得できます。
- テーブルに設定したフィールドと、フィールドの並び順
- グループフィールドに入れたフィールドと、そのレイアウト
- ラベル/スペース/罫線の設定
フィールドの一覧を取得する場合は、 フィールドの一覧を取得する API を利用してください。
URL
URL は、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。
運用環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/app/form/layout.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/app/form/layout.json
動作テスト環境の設定を取得する場合
- 通常のアプリ
- https://sample.cybozu.com/k/v1/preview/app/form/layout.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/preview/app/form/layout.json
HTTPメソッド
GET
必要なアクセス権
運用環境の設定を取得する場合
次のいずれかの権限が必要です。
- アプリのレコード閲覧権限
- アプリのレコード追加権限
動作テスト環境の設定を取得する場合
- アプリ管理権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリ ID |
リクエストの例(URL にパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/form/layout.json?app=8
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例(リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/app/form/layout.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
layout | 配列 | フォームの行ごとのレイアウトの一覧 |
layout[].type | 文字列 | 行の種類
|
layout[].code | 文字列 | テーブル、またはグループのコード テーブル、グループ以外の行では、このパラメーターは出力されません。 |
layout[].fields | 配列 | 行に含まれるフィールドの一覧 |
layout[].fields[].type | 文字列 | フィールドの種類
|
layout[].fields[].code | 文字列 | フィールドコード |
layout[].fields[].label | 文字列 | ラベル名 ラベルフィールドで出力されます。 |
layout[].fields[].elementId | 文字列 | 要素 ID スペースフィールドで出力されます。 |
layout[].fields[].size | オブジェクト | フィールドのサイズ PC で表示したときのフィールドサイズです。モバイルで表示したときのフィールドサイズは取得できません。 |
layout[].fields[].size.width | 文字列 | ピクセル単位でのフィールドの横幅 |
layout[].fields[].size.height | 文字列 | フィールド名を含めた、ピクセル単位でのフィールドの縦幅 |
layout[].fields[].size.innerHeight | 文字列 | フィールド名を除いた、ピクセル単位でのフィールドの縦幅 |
layout[].layout | 配列 | グループ内のフィールドのレイアウトの一覧 |
revision | 文字列 | アプリの設定のリビジョン番号 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|