kintone APIドキュメント

フィールドを取得する

目次

フィールドを取得する

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

フィールドの一覧とその設定を取得します。
フォームのレイアウトを取得する場合は、フォームのレイアウトを取得するAPIを利用してください。
フォームのレイアウトを取得するAPI

URL

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

URLは、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/form/fields.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/form/fields.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/form/fields.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/form/fields.json

HTTPメソッド

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

GET

必要なアクセス権

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

運用環境の設定を取得する場合

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

  • アプリのレコード閲覧権限
  • アプリのレコード追加権限
  • アプリの管理権限
動作テスト環境の設定を取得する場合
  • アプリ管理権限

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリID
lang 文字列 省略可 取得する名称の言語
フィールドや選択肢の名前に言語ごとの名称を設定している場合に指定します。
言語ごとの名称 (External link)
  • ja：日本語
  • en：英語
  • zh：中国語
  • user：APIを実行するユーザーが表示言語に設定している言語
    言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
    • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
    • ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
      ロケールの設定 (External link)
  • default：デフォルト
省略すると、デフォルトの名称を取得します。
リクエストの例（URLにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/app/form/fields.json?app=8

ヘッダー
1
2
3

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

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

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

https://sample.cybozu.com/k/v1/app/form/fields.json

ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4

{
  "app": "8",
  "lang": "ja"
}

レスポンス

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

プロパティ
プロパティ名 値の種類 説明
properties オブジェクト フィールドの設定
properties.フィールドコード オブジェクト 各フィールドコードの情報
properties.フィールドコード.label 文字列 フィールド名
properties.フィールドコード.code 文字列 フィールドコード
properties.フィールドコード.type 文字列 フィールドの種類
  • CALC：計算
  • CATEGORY：カテゴリー
  • CHECK_BOX：チェックボックス
  • CREATED_TIME：作成日時
  • CREATOR：作成者
  • DATE：日付
  • DATETIME：日時
  • DROP_DOWN：ドロップダウン
  • FILE：添付ファイル
  • GROUP：グループ
  • GROUP_SELECT：グループ選択
  • LINK：リンク
  • MODIFIER：更新者
  • MULTI_LINE_TEXT：文字列（複数行）
  • MULTI_SELECT：複数選択
  • NUMBER：数値
  • ORGANIZATION_SELECT：組織選択
  • RADIO_BUTTON：ラジオボタン
  • RECORD_NUMBER：レコード番号
  • REFERENCE_TABLE：関連レコード一覧
  • RICH_TEXT：リッチエディター
  • SINGLE_LINE_TEXT：文字列（1行）
  • STATUS：プロセス管理機能のステータス
  • STATUS_ASSIGNEE：プロセス管理機能の作業者
  • SUBTABLE：テーブル
  • TIME：時刻
  • UPDATED_TIME：更新日時
  • USER_SELECT：ユーザー選択
ルックアップフィールドは、コピー元のフィールドのフィールドタイプで指定します。
properties.フィールドコード.noLabel 真偽値 フィールド名を非表示にするかどうか
  • true：非表示
  • false：表示
properties.フィールドコード.required 真偽値 入力が必須かどうか
  • true：必須
  • false：任意
properties.フィールドコード.unique 真偽値 重複を禁止するかどうか
  • true：重複を禁止する
  • false：重複を許可する
properties.フィールドコード.maxValue 文字列 最大値
設定されていない場合には、空文字が返ります。
properties.フィールドコード.minValue 文字列 最小値
設定されていない場合には、空文字が返ります。
properties.フィールドコード.maxLength 文字列 最大文字数
設定されていない場合には、空文字が返ります。
properties.フィールドコード.minLength 文字列 最小文字数
設定されていない場合には、空文字が返ります。
properties.フィールドコード.defaultValue 文字列または配列 初期値
複数の初期値を設定できるフィールドでは、配列が返ります。
properties.フィールドコード.defaultNowValue 真偽値 レコード登録時の日時を初期値にするかどうか
  • true：レコード登録時の日時を初期値にする
  • false：レコード登録時の日時を初期値にしない
properties.フィールドコード.options オブジェクト 選択肢の設定
properties.フィールドコード.options.（選択肢名）.label 文字列 選択肢名
properties.フィールドコード.options.（選択肢名）.index 文字列 選択肢の順番（昇順）
properties.フィールドコード.align 文字列 選択肢の並び
  • HORIZONTAL：横
  • VERTICAL：縦
properties.フィールドコード.expression 文字列 自動計算式
設定されていない場合には、空文字が返ります。
properties.フィールドコード.hideExpression 真偽値 計算フィールドの計算式を非表示にするかどうか
  • true：非表示
  • false：表示
properties.フィールドコード.digit 真偽値 数値の桁区切りを表示するかどうか
  • true：桁区切りを表示する
  • false：桁区切りを表示しない
properties.フィールドコード.thumbnailSize 文字列 画像のサムネイルの大きさ（ピクセル単位）
properties.フィールドコード.protocol 文字列 リンクの種類
  • WEB：Webサイト
  • CALL：電話番号
  • MAIL：メールアドレス
properties.フィールドコード.format 文字列 計算フィールドの表示形式
  • NUMBER：数値（例：1000）
  • NUMBER_DIGIT：数値（例：1,000）
  • DATETIME：日時（例：2012-08-06 2:03）
  • DATE：日付（例：2012-08-06）
  • TIME：時刻（例：2:03）
  • HOUR_MINUTE：時間（例：26時間3分）
  • DAY_HOUR_MINUTE：時間（例：1日2時間3分）
properties.フィールドコード.displayScale 文字列 小数点以下の表示桁数
設定されていない場合には、空文字が返ります。
properties.フィールドコード.unit 文字列 単位記号
properties.フィールドコード.unitPosition 文字列 単位記号の表示位置
  • BEFORE：フィールドの前に付ける
  • AFTER：フィールドの後ろに付ける
properties.フィールドコード.entities 配列 選択肢のユーザーの一覧
設定されていない場合には、空文字が返ります。
properties.フィールドコード.entities[].code 文字列 選択肢のユーザーのログイン名、またはグループや組織のコード
properties.フィールドコード.entities[].type 文字列 値の種類
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
properties.フィールドコード.referenceTable オブジェクト 関連レコード一覧フィールドの設定
参照先のアプリにレコード閲覧権限、レコード追加権限、アプリ管理権限のいずれもない場合は「null」が返ります。
properties.フィールドコード.referenceTable.relatedApp オブジェクト 「参照するアプリ」の設定
properties.フィールドコード.referenceTable.relatedApp.app 文字列 「参照するアプリ」に指定されたアプリのアプリID
properties.フィールドコード.referenceTable.relatedApp.code 文字列 「参照するアプリ」に指定されたアプリのアプリコード
アプリコードが設定されていない場合には、空文字が返ります。
properties.フィールドコード.referenceTable.condition オブジェクト 「表示するレコードの条件」の設定
properties.フィールドコード.referenceTable.condition.field 文字列 「表示するレコードの条件」で指定された、関連レコード一覧フィールドと同じアプリのフィールドのフィールドコード
properties.フィールドコード.referenceTable.condition.relatedField 文字列 「表示するレコードの条件」で指定された、関連レコード一覧フィールドが参照するアプリのフィールドのフィールドコード
properties.フィールドコード.referenceTable.filterCond 文字列 「さらに絞り込む条件」の設定
クエリ形式で返ります。クエリ形式の詳細は次のページを参照してください。
クエリの書き方
properties.フィールドコード.referenceTable.displayFields 配列 「表示するフィールド」に指定されたフィールドコードの一覧
properties.フィールドコード.referenceTable.sort 文字列 レコードのソートの設定
クエリ形式で返ります。クエリ形式の詳細は次のページを参照してください。
クエリの書き方
properties.フィールドコード.referenceTable.size 文字列 一度に表示する最大レコード数
properties.フィールドコード.lookup オブジェクト ルックアップフィールドの設定
参照先のアプリにレコード閲覧権限、レコード追加権限、アプリ管理権限のいずれもない場合は「null」が返ります。
properties.フィールドコード.lookup.relatedApp オブジェクト 「関連付けるアプリ」の設定
properties.フィールドコード.lookup.relatedApp.app 文字列 関連付けたアプリのアプリID
properties.フィールドコード.lookup.relatedApp.code 文字列 関連付けたアプリのアプリコード
アプリコードが設定されていない場合には、空文字が返ります。
properties.フィールドコード.lookup.relatedKeyField 文字列 「コピー元のフィールド」に指定されたフィールドのフィールドコード
properties.フィールドコード.lookup.fieldMappings 配列 「ほかのフィールドのコピー」の設定の一覧
設定されていない場合には、空文字が返ります。
properties.フィールドコード.lookup.fieldMappings[].field 文字列 「ほかのフィールドのコピー」のコピー先に指定されたフィールドのフィールドコード
properties.フィールドコード.lookup.fieldMappings[].relatedField 文字列 「ほかのフィールドのコピー」のコピー元に指定されたフィールドのフィールドコード
properties.フィールドコード.lookup.lookupPickerFields 配列 「コピー元のレコードの選択時に表示するフィールド」の設定を表すフィールドコードの一覧
設定されていない場合には、空文字が返ります。
properties.フィールドコード.lookup.filterCond 文字列 絞り込みの初期設定
クエリ形式で返ります。クエリ形式の詳細は次のページを参照してください。
クエリの書き方
properties.フィールドコード.lookup.sort 文字列 ソートの初期設定
クエリ形式で返ります。クエリ形式の詳細は次のページを参照してください。
クエリの書き方
properties.フィールドコード.openGroup 真偽値 グループ内のフィールドを表示するかどうか
  • true：表示
  • false：非表示
properties.フィールドコード.fields オブジェクト テーブル内のフィールド
オブジェクトの構造は、propertiesと同じです。
properties.フィールドコード.enabled 真偽値 機能が有効かどうか
このパラメーターは、ステータスフィールド、およびカテゴリーフィールドでのみ出力されます。
  • ステータスフィールドの場合
    • true：プロセス管理機能が有効
    • false：プロセス管理機能が無効
  • カテゴリーフィールドの場合
    • true：カテゴリー機能が有効
    • false：カテゴリー機能が無効
revision 文字列 アプリの設定のリビジョン番号
レスポンスの例
  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
244

{
  "properties": {
    "文字列1行_0": {
      "type": "SINGLE_LINE_TEXT",
      "code": "文字列1行_0",
      "label": "文字列 (1行)",
      "noLabel": false,
      "required": true,
      "unique": true,
      "maxLength": "64",
      "minLength": "0",
      "defaultValue": "",
      "expression": "",
      "hideExpression": false
    },
    "数値_0": {
      "type": "NUMBER",
      "code": "数値_0",
      "label": "数値",
      "noLabel": true,
      "required": false,
      "unique": false,
      "maxValue": "64",
      "minValue": "0",
      "defaultValue": "12345",
      "expression": "",
      "digit": true,
      "displayScale": "",
      "unit": "$",
      "unitPosition": "BEFORE"
    },
    "ラジオボタン_0": {
      "type": "RADIO_BUTTON",
      "code": "ラジオボタン_0",
      "label": "ラジオボタン",
      "noLabel": false,
      "required": true,
      "defaultValue": "sample2",
      "options": {
        "sample1": {
          "label": "sample1",
          "index": "0"
        },
        "sample2": {
          "label": "sample2",
          "index": "1"
        },
        "sample3": {
          "label": "sample3",
          "index": "2"
        }
      },
      "align": "horizontal"
    },
    "チェックボックス_0": {
      "type": "CHECK_BOX",
      "code": "チェックボックス_0",
      "label": "チェックボックス",
      "noLabel": false,
      "required": false,
      "defaultValue": ["sample1", "sample3"],
      "options": {
        "sample1": {
          "label": "sample1",
          "index": "0"
        },
        "sample2": {
          "label": "sample2",
          "index": "2"
        },
        "sample3": {
          "label": "sample3",
          "index": "1"
        }
      },
      "align": "horizontal"
    },
    "日付_0": {
      "type": "DATE",
      "code": "日付_0",
      "label": "日付",
      "noLabel": false,
      "required": false,
      "unique": true,
      "defaultValue": "",
      "defaultNowValue": true
    },
    "日時_0": {
      "type": "DATETIME",
      "code": "日時_0",
      "label": "日時",
      "noLabel": false,
      "required": false,
      "unique": false,
      "defaultValue": "2012-07-19T00:00Z",
      "defaultNowValue": false
    },
    "添付ファイル_0": {
      "type": "FILE",
      "code": "添付ファイル_0",
      "label": "添付ファイル",
      "noLabel": true,
      "required": false,
      "thumbnailSize": "150"
    },
    "リンク_0": {
      "type": "LINK",
      "code": "リンク_0",
      "label": "リンク",
      "noLabel": true,
      "required": false,
      "unique": false,
      "defaultValue": "https://example.com",
      "maxLength": "64",
      "minLength": "0",
      "protocol": "WEB"
    },
    "ユーザー選択_0": {
      "type": "USER_SELECT",
      "code": "ユーザー選択_0",
      "label": "ユーザー選択",
      "noLabel": true,
      "required": false,
      "defaultValue": [
        {
          "code": "user1",
          "type": "USER"
        },
        {
          "code": "group1",
          "type": "GROUP"
        },
        {
          "code": "org1",
          "type": "ORGANIZATION"
        },
        {
          "code": "LOGINUSER()",
          "type": "FUNCTION"
        }
      ],
      "entities": [
        {
          "code": "user1",
          "type": "USER"
        },
        {
          "code": "group1",
          "type": "GROUP"
        }
      ]
    },
    "関連レコード一覧_0": {
      "type": "REFERENCE_TABLE",
      "code": "関連レコード一覧_0",
      "label": "関連レコード一覧",
      "noLabel": true,
      "referenceTable": {
        "relatedApp": {
          "app": "3",
          "code": "参照先アプリ"
        },
        "condition": {
          "field": "このアプリのフィールド",
          "relatedField": "参照するアプリのフィールド"
        },
        "filterCond": "数値_0 > 10 and 数値_1 > 20",
        "displayFields": ["表示するフィールド_0", "表示するフィールド_1"],
        "sort": "數值_0 desc, 數值_1 asc",
        "size": "5"
      }
    },
    "ルックアップ_0": {
      "type": "SINGLE_LINE_TEXT",
      "code": "ルックアップ_0",
      "label": "ルックアップ",
      "noLabel": true,
      "required": false,
      "lookup": {
        "relatedApp": {
          "app": "100",
          "code": "コピー元アプリのアプリコード"
        },
        "relatedKeyField": "コピー元のフィールド",
        "fieldMappings": [
          {
            "field": "コピー先のフィールド",
            "relatedField": "コピー元のフィールド"
          }
        ],
        "lookupPickerFields": ["ルックアップ選択時に表示されるフィールド1"],
        "filterCond": "数値_0 > 10 and 数値_1 > 20",
        "sort": "數值_0 desc, 數值_1 asc"
      }
    },
    "グループ_0": {
      "type": "GROUP",
      "code": "グループ_0",
      "label": "グループ",
      "noLabel": true,
      "openGroup": true
    },
    "テーブル_0": {
      "type": "SUBTABLE",
      "code": "テーブル_0",
      "label": "テーブル",
      "noLabel": false,
      "fields": {
        "文字列__1行_テーブル": {
          "type": "SINGLE_LINE_TEXT",
          "code": "文字列__1行_テーブル",
          "label": "文字列 (1行)テーブル",
          "noLabel": false,
          "required": true,
          "unique": false,
          "maxLength": "64",
          "minLength": "0",
          "defaultValue": "",
          "expression": "",
          "hideExpression": false
        }
      }
    },
    "ステータス": {
      "type": "STATUS",
      "code": "ステータス",
      "label": "ステータス",
      "enabled": "true"
    },
    "作業者": {
      "type": "STATUS_ASSIGNEE",
      "code": "作業者",
      "label": "作業者",
      "enabled": "true"
    },
    "カテゴリー": {
      "type": "CATEGORY",
      "code": "カテゴリー",
      "label": "カテゴリー",
      "enabled": "true"
    }
  },
  "revision": "2"
}

サンプルコード

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

curlを使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/form/fields.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "lang": "ja"
  }'
kintone.api()を使ったリクエスト

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

1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

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