カテゴリー内の他の記事

フォーム設計情報取得

フォローする

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
  • フィールド名
  • フィールドタイプ
文字列(1行) 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 コミュニティをご活用ください。

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