フォーム設計情報取得

こちらのAPIは将来的に廃止予定です。
廃止時期については、利用状況をモニターしながら決定します。決定次第、ご案内します。
フォーム設定情報を取得できる新しいAPI（form/fields.json、form/layout.json）を利用してください。
アプリのフォーム情報を取得するライブラリ kintone-config-helper も活用できます。

Index

フォーム設計情報取得
開発中アプリのフォーム設計情報

アプリの閲覧権限のあるユーザーが、フォームの設計情報を取得できます。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/k/v1/form.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/form.json

リクエストパラメータ

パラメータ名	値	必須	説明
app	数値又は文字列	必須	フォームの設計情報を取得するアプリの ID を指定します。

リクエストの例

パラメータを HTTP のクエリ文字列で送信する場合

「app」パラメータを、HTTP のクエリ文字列として送信します。

HTTP のクエリ文字列

app=4

リクエストヘッダを含んだ例

GET https://example.cybozu.com/k/v1/form.json?app=4 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

Content-Typeヘッダは不要です。

パラメータを JSON形式で送信する場合（HTTP リクエストのリクエストボディに JSON データをセットする場合）

リクエストボディの JSON データ例は以下の通りです。

リクエストヘッダ

GET /k/v1/form.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

Content-Type に application/json を指定して下さい。指定しない場合は JSON が解釈できないため、実行時エラーとなります。

ボディ

レスポンスの例

処理成功時は各フィールドのプロパティが単一の JSON データとして取得されます。

プロパティ

プロパティ名	キー名	取りうる値	例
フィールド名	label	文字列（空文字にはならない）	"label": "タイトル"
フィールドコード	code	文字列（空文字にはならない）	"code": "フィールドコード"
要素ID	elementId	文字列（空文字にはならない）	"elementId": "Space"
フィールドタイプ	type	下記「各フィールドで取得するプロパティ」参照	"type": "CHECK_BOX"
フィールド名の非表示	noLabel	"true" または "false"	"noLabel": "true"
必須可否	required	"true" または "false"	"required": "true"
重複可否	unique	"true" または "false"	"unique": "true"
値の制限(数値)
	maxValue	数値または文字列または null	"maxValue": "1"
	minValue	数値または文字列または null	"minValue": "100"
文字数の制限	maxLength	数値または文字列または null	"maxLength": "5"
文字数の制限	minLength	数値または文字列または null	"minLength": "2"
初期値	defaultValue	文字列または空文字または null	"defaultValue":"初期値です" ※複数初期値が指定できるフィールドの場合は配列で値が返ります。
初期値の式(日付、時刻、日時)	defaultExpression	"NOW" または null	"defaultExpression":"NOW" ※日付、時刻、日時の初期値に現在の日付、時刻、日時が指定されている場合はNOWが返り、このときのdefaultValueはnullとなります。 ※defaultExpressionがnullの場合は初期値はdefaultValueの値となります。
項目(選択系)	options	文字列の配列（空文字列にはならない）	"options":["A","B","C"]
自動計算	expression	文字列または ""	"expression":"金額 * 数量" ※計算式はフィールドコードで記述されます。
数値の桁区切り	digit	"true" または "false"	"digit":"true"
種類(リンク)	protocol	"WEB": Webサイト "CALL":電話番号 "MAIL":メールアドレス	"protocol":"WEB"
表示書式	format	"NUMBER": 数値又は文字列 "NUMBER_DIGIT": 数値（桁区切り）又は文字列 "DATETIME": 日時 "DATE": 日付 "TIME": 時刻 "HOUR_MINUTE": 時間量（時分） "DAY_HOUR_MINUTE": 時間量（日時分）	"format":"NUMBER"
小数点以下の表示桁数	displayScale	小数点以下の表示桁数。未設定の場合はnull。	"displayScale": "4"
計算式の非表示	hideExpression	"true" または "false"	"hideExpression": "false"
ルックアップ、関連レコード一覧の参照元アプリのID	relatedApp	数値（参照元アプリの権限がない場合はnull）又は文字列	"relatedApp":"123"
テーブル内のフィールド	fields	配列	"fields": [ { "code": "文字列__1行_テーブル", "defaultValue": "", "expression": "", "hideExpression": "false", "maxLength": "64", "minLength": null, "label": "文字列 (1行)テーブル", "noLabel": "false", "required": "true", "type": "SINGLE_LINE_TEXT", "unique": "true" }, { "code": "数値テーブル", "defaultValue": "12345", "digit": "true", "displayScale": null, "expression": "", "maxValue": null, "minValue": null, "label": "数値テーブル", "noLabel": "true", "required": "false", "type": "NUMBER", "unique": "false" } ]
単位記号	unit	文字列(未設定の場合はnull)	"unit": "$"
単位記号の位置	unitPosition	"BEFORE":前に付ける "AFTER":後ろに付ける単位記号の設定に関わらず、保存している"BEFORE" または、"AFTER"を返す。フォームに配置直後は"BEFORE"となる。	"unitPosition": "BEFORE"

フィールドごとの取得できるプロパティ

フィールド型	タイプ	取得するプロパティ
ラベル	LABEL	フィールド名フィールドタイプ
文字列（１行）	SINGLE_LINE_TEXT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示重複可否文字数の(最大文字数と最小文字数) 初期値自動計算計算式の非表示
数値	NUMBER	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示重複可否値の制限値(最大値と最小値) 初期値数値の桁区切り小数点以下の表示桁数
計算	CALC	フィールド名フィールドコードフィールドタイプ必須可否（常にfalse）フィールド名の非表示自動計算表示書式小数点以下の表示桁数計算式の非表示
文字列（複数行）	MULTI_LINE_TEXT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示初期値
リッチエディター	RICH_TEXT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示初期値
チェックボックス	CHECK_BOX	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示初期値項目
ラジオボタン	RADIO_BUTTON	フィールド名フィールドコードフィールドタイプ必須可否（常にtrue）フィールド名の非表示項目初期値
ドロップダウン	DROP_DOWN	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示項目初期値
複数選択	MULTI_SELECT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示項目初期値
添付ファイル	FILE	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示
日付	DATE	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示重複可否初期値初期値の式
時刻	TIME	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示初期値初期値の式
日時	DATETIME	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示重複可否初期値初期値の式
リンク	LINK	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示重複可否種類文字数の制限(最大文字数と最小文字数) 初期値
スペース	SPACER	要素ID フィールドタイプ
罫線	HR	フィールドタイプ
ユーザー選択	USER_SELECT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示
ルックアップ	SINGLE_LINE_TEXT	フィールド名フィールドコード必須可否フィールド名の非表示参照するアプリID 参照するフィールドのタイプ
関連レコード一覧	REFERENCE_TABLE	フィールド名フィールドコードフィールドタイプフィールド名の非表示参照するアプリのID
レコード番号	RECORD_NUMBER	フィールド名フィールドコードフィールドタイプフィールド名の非表示
作成者	CREATOR	フィールド名フィールドコードフィールドタイプフィールド名の非表示
作成日時	CREATED_TIME	フィールド名フィールドコードフィールドタイプフィールド名の非表示
更新者	MODIFIER	フィールド名フィールドコードフィールドタイプフィールド名の非表示
更新日時	UPDATED_TIME	フィールド名フィールドコードフィールドタイプフィールド名の非表示
テーブル	SUBTABLE	フィールドコードフィールドタイプ中に含まれるフィールドの情報
組織選択フィールド	ORGANIZATION_SELECT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示
グループ選択フィールド	GROUP_SELECT	フィールド名フィールドコードフィールドタイプ必須可否フィールド名の非表示

取得できないフィールド

カテゴリー
ステータス
グループ
グループフィールド内の下記のフィールド
組み込みフィールド（レコード番号、作成者、作成日時、更新者、更新日時）、スペース、ラベル、罫線

サンプル

kintone.api() を使用してフォーム設計情報取得時にメッセージを表示します。

XMLHttpRequestを使用してリクエストを送信する場合。

開発中アプリのフォーム設計情報取得

アプリの管理権限のあるユーザーが、開発中アプリのフォームの設計情報を取得できます。

HTTP メソッド

GET

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/form.json

ゲストスペース内のアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/form.json

※リクエストパラメータ及びレスポンスのプロパティについては、フォーム設計情報取得APIと同等です。

JavaScriptサンプル

kintone REST API

XMLHttpRequest

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

kuma 2018年08月31日 00:52

お世話になります。

フィールドごとの取得できるプロパティを変数に代入したいときはどのように記述すればよいのでしょうか。

kuma 2018年08月31日 01:16

具体的にはoptionでドロップダウンフィールドの項目名を取得したいと思っています。

console.log(resp.properties.フィールドコード.options);

のように記述してみましたが、TypeError: resp.properties.\u5927\u9805\u76EE is undefined　が返ってきて

しまいました。

最終的にはドロップダウンのフィールド項目をすべて配列に格納したいと思っています。

cybozu Development team 2018年08月31日 03:49

kumaさん

ご質問いただきありがとうございます。cybozu developer network運営事務局です。
ドロップダウンフィールドの項目名の取得についてですが、
resp.propertiesは配列になっているので、以下の順で処理することになります。

resp.properties 配列の中から、ループ処理でcode要素がドロップダウンフィールドのフィールドコードに合致するものを抜き出す
抜き出した要素内のoptionsの値を取得する

ご確認よろしくお願いします。
またご不明点ございましたらコメントください。

kuma 2018年08月31日 08:11

ご返信いただき、ありがとうございます。

ご教授いただいた方法で無事アプリ内の全てのドロップボックスの要素名が取得できました。

ありがとうございました。

参考までに作成したコードを置いておきます。

(function () {

'use strict';

kintone.events.on("app.record.index.show", function (event) {

//フォーム設計情報の取得

var body= {

"app":143

};

kintone.api(kintone.api.url('/k/v1/form', true), 'GET', body, function(resp) {

// success

console.log(resp);

for(var k=0; k<resp.properties.length; k++){

if(resp.properties[k].code === "DROP_DOWN"){

var box=resp.properties[k].options;

console.log(box);

}

}, function(error) {

// error

console.log(error);

});

})();

kumaにより編集されました 2018年09月03日 06:11

cybozu Development team 2018年08月31日 08:37

無事取得できたとのこと、良かったです。
サンプルコードも添付いただきありがとうございます。

また何かありましたら、ご連絡ください。

ログインしてコメントを残してください。