フォームの設計情報を取得する

固定リンクがコピーされました

フォームの設計情報を取得します。

文字列（1行）フィールドのプロパティ
文字列（複数行）のプロパティ
リッチエディターのプロパティ
数値のプロパティ
計算のプロパティ
ラジオボタンのプロパティ
チェックボックスのプロパティ
複数選択のプロパティ
ドロップダウンのプロパティ
ユーザー選択のプロパティ
組織選択のプロパティ
グループ選択のプロパティ
日付のプロパティ
時刻のプロパティ
日時のプロパティ
添付ファイルのプロパティ
リンクのプロパティ
関連レコード一覧のプロパティ
ルックアップのプロパティ
テーブルのプロパティ
ラベルのプロパティ
スペースのプロパティ
罫線のプロパティ
レコード番号のプロパティ
作成者のプロパティ
作成日時のプロパティ
更新者のプロパティ
更新日時のプロパティ

必要なアクセス権
サンプル
補足
制限事項

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/form.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/form.json
URL（動作テスト環境）	https://sample.cybozu.com/k/v1/preview/form.json
URL（動作テスト環境のゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/form.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリのID

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties	配列	アプリを構成するフィールドの一覧 `properties[].type`ごとに、フィールドの内容が異なります。詳細は別表に記載しています。
properties[].type	文字列	フィールドのタイプタイプによって、次の値が返ります。 `SINGLE_LINE_TEXT`：文字列（1行） `MULTI_LINE_TEXT`：文字列（複数行） `RICH_TEXT`：リッチエディター `NUMBER`：数値 `CALC`：計算 `RADIO_BUTTON`：ラジオボタン `CHECK_BOX`：チェックボックス `MULTI_SELECT`：複数選択 `DROP_DOWN`：ドロップダウン `USER_SELECT`：ユーザー選択 `ORGANIZATION_SELECT`：組織選択 `GROUP_SELECT`：グループ選択 `DATE`：日付 `TIME`：時刻 `DATETIME`：日時 `FILE`：添付ファイル `LINK`：リンク `REFERENCE_TABLE`：関連レコード一覧 `SUBTABLE`：テーブル `LABEL`：ラベル `SPACER`：スペース `HR`：罫線 `RECORD_NUMBER`：レコード番号 `CREATOR`：作成者 `CREATED_TIME`：作成日時 `MODIFIER`：更新者 `UPDATED_TIME`：更新日時ルックアップの場合、コピー元のフィールドのタイプが返ります。

文字列（1行）フィールドのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「SINGLE_LINE_TEXT」が返ります。
properties[].label	文字列	フィールド名
properties[].expression	文字列	自動計算で設定された式
properties[].hideExpression	文字列	計算式を表示しないかどうか `true`：表示しない `false`：表示する
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].unique	文字列	値の重複を許可するかどうか `true`：重複を許可する `false`：重複を許可しない
properties[].minLength	文字列	文字数（最小）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].maxLength	文字列	文字数（最大）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

文字列（複数行）のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「MULTI_LINE_TEXT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

リッチエディターのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「RICH_TEXT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

数値のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「NUMBER」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].digit	文字列	桁区切りを表示するかどうか `true`：表示する `false`：表示しない
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].unique	文字列	値の重複を許可するかどうか `true`：重複を許可する `false`：重複を許可しない
properties[].minValue	文字列	値の制限（最小）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].maxValue	文字列	値の制限（最大）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].displayScale	文字列	小数点以下の表示桁数整数が返ります。設定されていない場合には、「null」が返ります。
properties[].unit	文字列	単位記号設定されていない場合には、「null」が返ります。
properties[].unitPosition	文字列	単位記号を付ける位置次の値が返ります。 `BEFORE`：前に付ける `AFTER`：後に付ける
properties[].code	文字列	フィールドコード

計算のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「CALC」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか「false」が返ります。
properties[].expression	文字列	自動計算で設定された式
properties[].hideExpression	文字列	計算式を表示しないかどうか `true`：表示しない `false`：表示する
properties[].format	文字列	フォーマット次のいずれかの値が返ります。 `NUMBER`: 数値 `NUMBER_DIGIT`: 数値（桁区切り） `DATETIME`: 日時 `DATE`: 日付 `TIME`: 時刻 `HOUR_MINUTE`: 時間量（時分） `DAY_HOUR_MINUTE`: 時間量（日時分）
properties[].displayScale	文字列	小数点以下の表示桁数整数が返ります。設定されていない場合には、「null」が返ります。
properties[].unit	文字列	単位記号設定されていない場合には、「null」が返ります。
properties[].unitPosition	文字列	単位記号を付ける位置次の値が返ります。 `BEFORE`：前に付ける `AFTER`：後に付ける
properties[].code	文字列	フィールドコード

ラジオボタンのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「RADIO_BUTTON」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか「true」が返ります。
properties[].options	配列（配列）	項目の一覧
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

チェックボックスのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「CHECK_BOX」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].options	配列（配列）	項目の一覧
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

複数選択のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「MULTI_SELECT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].options	配列（配列）	項目の一覧
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

ドロップダウンのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「DROP_DOWN」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].options	配列（配列）	項目の一覧
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

ユーザー選択のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「USER_SELECT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].code	文字列	フィールドコード

組織選択のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「ORGANIZATION_SELECT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].code	文字列	フィールドコード

グループ選択のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「GROUP_SELECT」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].code	文字列	フィールドコード

日付のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「DATE」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].unique	文字列	値の重複を許可するかどうか `true`：重複を許可する `false`：重複を許可しない
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].defaultExpression	文字列	初期値に設定された式設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

時刻のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「TIME」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].defaultExpression	文字列	初期値に設定された式設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

日時のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「DATETIME」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].unique	文字列	値の重複を許可するかどうか `true`：重複を許可する `false`：重複を許可しない
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].defaultExpression	文字列	初期値に設定された式設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

添付ファイルのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「FILE」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].code	文字列	フィールドコード

リンクのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「LINK」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].unique	文字列	値の重複を許可するかどうか `true`：重複を許可する `false`：重複を許可しない
properties[].protocol	文字列	リンクの種類次のいずれかの値が返ります。 `WEB`：Webサイト `CALL`：電話番号 `MAIL`メールアドレス
properties[].minLength	文字列	文字数（最小）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].maxLength	文字列	文字数（最大）整数が返ります。設定されていない場合には、「null」が返ります。
properties[].defaultValue	文字列	初期値設定されていない場合には、「null」が返ります。
properties[].code	文字列	フィールドコード

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「REFERENCE_TABLE」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].relatedApp	数字	参照するアプリのアプリID
properties[].code	文字列	フィールドコード

ルックアップのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプコピー元のフィールドのタイプによって、次のいずれかの値が返ります。 `SINGLE_LINE_TEXT`：文字列（1行） `NUMBER`：数値 `LINK`：リンク
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].required	文字列	必須項目にするかどうか `true`：必須項目にする `false`：必須項目にしない
properties[].relatedApp	数字	参照するアプリのアプリID
properties[].code	文字列	フィールドコード

テーブルのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「SUBTABLE」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].fields	配列	テーブル内のフィールドの一覧
properties[].code	文字列	フィールドコード

ラベルのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「LABEL」が返ります。
properties[].label	文字列	フィールド名

スペースのプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「SPACER」が返ります。
properties[].elementId	文字列	要素のID

罫線のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「HR」が返ります。

レコード番号のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「RECORD_NUMBER」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].code	文字列	フィールドコード

作成者のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「CREATOR」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].code	文字列	フィールドコード

作成日時のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「CREATED_TIME」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].code	文字列	フィールドコード

更新者のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「MODIFIER」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].code	文字列	フィールドコード

更新日時のプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
properties[].type	文字列	フィールドのタイプ「UPDATED_TIME」が返ります。
properties[].label	文字列	フィールド名
properties[].noLabel	文字列	フィールド名を表示しないどうか `true`：表示しない `false`：表示する
properties[].code	文字列	フィールドコード

必要なアクセス権

固定リンクがコピーされました

次のいずれかの権限が必要です。

アプリのレコード閲覧権限
アプリのレコード追加権限

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/form.json?app=4

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/form.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3


{
  "app": 4
}

サンプルレスポンス

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243


{
  "properties": [
    {
      "type": "LABEL",
      "label": "ラベル"
    },
    {
      "type": "SINGLE_LINE_TEXT",
      "label": "文字列 (1行)",
      "noLabel": "false",
      "code": "文字列__1行_",
      "required": "false",
      "minLength": null,
      "maxLength": "64",
      "expression": "",
      "hideExpression": "false",
      "unique": "false",
      "defaultValue": ""
    },
    {
      "type": "NUMBER",
      "label": "数値",
      "noLabel": "false",
      "code": "数値",
      "required": "false",
      "minValue": null,
      "maxValue": null,
      "digit": "false",
      "unique": "false",
      "defaultValue": null,
      "displayScale": null,
      "unit": null,
      "unitPosition": "BEFORE"
    },
    {
      "type": "CALC",
      "label": "計算",
      "noLabel": "false",
      "code": "計算",
      "required": "false",
      "expression": "100",
      "format": "NUMBER",
      "displayScale": null,
      "hideExpression": "false",
      "unit": null,
      "unitPosition": "BEFORE"
    },
    {
      "type": "MULTI_LINE_TEXT",
      "label": "文字列 (複数行)",
      "noLabel": "false",
      "code": "文字列__複数行_",
      "required": "false",
      "defaultValue": ""
    },
    {
      "type": "RICH_TEXT",
      "label": "リッチエディター",
      "noLabel": "false",
      "code": "リッチエディター",
      "required": "false",
      "defaultValue": ""
    },
    {
      "type": "CHECK_BOX",
      "label": "チェックボックス",
      "noLabel": "false",
      "code": "チェックボックス",
      "required": "false",
      "options": ["sample1", "sample2"],
      "defaultValue": []
    },
    {
      "type": "RADIO_BUTTON",
      "label": "ラジオボタン",
      "noLabel": "false",
      "code": "ラジオボタン",
      "required": "true",
      "options": ["sample1", "sample2"],
      "defaultValue": "sample1"
    },
    {
      "type": "DROP_DOWN",
      "label": "ドロップダウン",
      "noLabel": "false",
      "code": "ドロップダウン",
      "required": "false",
      "options": ["sample1", "sample2"],
      "defaultValue": null
    },
    {
      "type": "MULTI_SELECT",
      "label": "複数選択",
      "noLabel": "false",
      "code": "複数選択",
      "required": "false",
      "options": ["sample1", "sample2", "sample3", "sample4"],
      "defaultValue": []
    },
    {
      "type": "FILE",
      "label": "添付ファイル",
      "noLabel": "false",
      "code": "添付ファイル",
      "required": "false"
    },
    {
      "type": "DATE",
      "label": "日付",
      "noLabel": "false",
      "code": "日付",
      "required": "false",
      "unique": "false",
      "defaultValue": null,
      "defaultExpression": "NOW"
    },
    {
      "type": "TIME",
      "label": "時刻",
      "noLabel": "false",
      "code": "時刻",
      "required": "false",
      "defaultValue": null,
      "defaultExpression": "NOW"
    },
    {
      "type": "DATETIME",
      "label": "日時",
      "noLabel": "false",
      "code": "日時",
      "required": "false",
      "unique": "false",
      "defaultValue": null,
      "defaultExpression": "NOW"
    },
    {
      "type": "LINK",
      "label": "リンク",
      "noLabel": "false",
      "code": "リンク",
      "required": "false",
      "protocol": "WEB",
      "minLength": null,
      "maxLength": null,
      "unique": "false",
      "defaultValue": ""
    },
    {
      "type": "SPACER",
      "elementId": ""
    },
    {
      "type": "HR"
    },
    {
      "type": "USER_SELECT",
      "label": "ユーザー選択",
      "noLabel": "false",
      "code": "ユーザー選択",
      "required": "false"
    },
    {
      "type": "SINGLE_LINE_TEXT",
      "label": "ルックアップ",
      "noLabel": "false",
      "code": "ルックアップ",
      "required": "false",
      "relatedApp": "1"
    },
    {
      "type": "REFERENCE_TABLE",
      "label": "関連レコード一覧",
      "noLabel": "false",
      "code": "関連レコード一覧",
      "relatedApp": "1"
    },
    {
      "type": "RECORD_NUMBER",
      "label": "レコード番号",
      "noLabel": "false",
      "code": "レコード番号"
    },
    {
      "type": "CREATOR",
      "label": "作成者",
      "noLabel": "false",
      "code": "作成者"
    },
    {
      "type": "CREATED_TIME",
      "label": "作成日時",
      "noLabel": "false",
      "code": "作成日時"
    },
    {
      "type": "MODIFIER",
      "label": "更新者",
      "noLabel": "false",
      "code": "更新者"
    },
    {
      "type": "UPDATED_TIME",
      "label": "更新日時",
      "noLabel": "false",
      "code": "更新日時"
    },
    {
      "type": "SUBTABLE",
      "label": "テーブル",
      "noLabel": "false",
      "code": "Table",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "label": "文字列 (1行)",
          "noLabel": "false",
          "code": "文字列__1行__1",
          "required": "false",
          "minLength": null,
          "maxLength": null,
          "expression": "",
          "hideExpression": "false",
          "unique": "false",
          "defaultValue": ""
        }
      ]
    },
    {
      "type": "ORGANIZATION_SELECT",
      "label": "組織選択",
      "noLabel": "false",
      "code": "組織選択",
      "required": "false"
    },
    {
      "type": "GROUP_SELECT",
      "label": "グループ選択",
      "noLabel": "false",
      "code": "グループ選択",
      "required": "false"
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  app: kintone.app.getId()
};

await kintone.api(kintone.api.url('/k/v1/form.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2


curl -X GET 'https://sample.cybozu.com/k/v1/form.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \

補足

固定リンクがコピーされました

フォームの設計情報を更新したり、フォームのレイアウトやフィールドの一覧を取得したりするには、次のAPIを利用してください。
- フィールド
- フォームのレイアウト
  - フォームのレイアウトを取得する
  - フォームのレイアウトを変更する

制限事項

固定リンクがコピーされました

次のフィールドは取得できません。
- カテゴリー
- ステータス
- グループ
- グループフィールド内に配置された次のフィールド
  - レコード番号
  - 作成者
  - 作成日時
  - 更新者
  - 更新日時
  - スペース
  - ラベル
  - 罫線

kintone API

kintone APIドキュメント