カテゴリー内の他の記事

フォームの設定の変更

作成日2015年05月11日 09:34
更新日2022年06月21日 08:33

アプリのフォームの設定を変更します。
フォームの設定の変更には、次の操作ごとに異なるAPIを使用します。

フィールドを追加する
フォームにフィールドを追加します。
フィールドの設定を変更する
フォームのフィールドの設定を変更します。
フィールドを削除する
フォームからフィールドを削除します。
フォームのレイアウトを変更する
次の設定を変更します。

フィールドの縦幅と横幅
テーブルに設定するフィールドと、それらの順番
グループフィールドに入れるフィールドと、それらのレイアウト
ラベル、スペース、および罫線の設定

フィールドを追加する

フォームにフィールドを追加します。

このAPI は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。

URI

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

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/form/fields.json

HTTPメソッド

POST

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名	指定する値	必須	説明
app	数値または文字列	必須	アプリのIDを指定します。
properties	オブジェクト	必須	フィールドの設定を表すオブジェクトです。
properties.（フィールドコード）	オブジェクト	必須	各フィールドの設定を表すオブジェクトです。「（フィールドコード）」には追加するフィールドのフィールドコードを指定します。使用できる文字の制限については、kintoneヘルプを参照してください。
properties.（フィールドコード）.type	文字列	必須	フィールドの種類を指定します。グループ：GROUP グループ選択：GROUP_SELECT チェックボックス：CHECK_BOX テーブル：SUBTABLE ドロップダウン：DROP_DOWN ユーザー選択：USER_SELECT ラジオボタン：RADIO_BUTTON リッチエディター：RICH_TEXT リンク：LINK ルックアップ：SINGLE_LINE_TEXT、NUMBER または LINK 関連レコード一覧：REFERENCE_TABLE 計算：CALC 時刻：TIME 数値：NUMBER 組織選択：ORGANIZATION_SELECT 添付ファイル：FILE 日時：DATETIME 日付：DATE 複数選択：MULTI_SELECT 文字列（1行）：SINGLE_LINE_TEXT 文字列（複数行）：MULTI_LINE_TEXT ^*：参照先のフィールドの種類を指定します。
properties.（フィールドコード）.code	文字列	必須	フィールドコードを指定します。「properties.（フィールドコード）」のキー名と同じ値を指定します。
properties.（フィールドコード）.label	文字列	条件必須	フィールド名を指定します。テーブルでは、このパラメータの指定は不要です。
properties.（フィールドコード）.noLabel	真偽値または文字列		フィールド名を非表示にするかどうかを指定します。非表示にする場合：true 表示する場合（初期設定）：false
properties.（フィールドコード）.required	真偽値または文字列		入力が必須かどうかを指定します。必須の場合：true 任意の場合（初期設定）：false
properties.（フィールドコード）.unique	真偽値または文字列		重複を禁止するかどうかを指定します。重複を禁止する場合：true 重複を許可する場合（初期設定）：false
properties.（フィールドコード）.maxValue	数値または文字列		最大値を指定します。
properties.（フィールドコード）.minValue	数値または文字列		最小値を指定します。
properties.（フィールドコード）.maxLength	数値または文字列		最大文字数を指定します。
properties.（フィールドコード）.minLength	数値または文字列		最小文字数を指定します。
properties.（フィールドコード）.defaultValue	文字列または配列		初期値を指定します。複数の初期値を設定できるフィールドでは、配列形式で指定します。「defaultNowValue」パラメータを指定した場合、「defaultNowValue」パラメータの指定が優先されます。ユーザー選択、グループ選択、組織選択フィールドの場合codeとtypeを持つオブジェクトの配列を指定します。
properties.（フィールドコード）.defaultValue[].type	文字列	条件必須	ユーザー選択、グループ選択、組織選択フィールドの場合の初期値の種類を指定します。「defaultValue」パラメータを指定する場合、このパラメータは必須です。ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION 関数の場合：FUNCTION
properties.（フィールドコード）.defaultValue[].code	文字列	条件必須	ユーザー選択、グループ選択、組織選択フィールドの場合の初期値のコードを指定します。「defaultValue」パラメータを指定する場合、このパラメータは必須です。ユーザー選択フィールドの場合：ユーザーのログイン名、グループのコード、組織のコード、関数名のいずれかを指定します。関数名にはログインユーザーを指定する関数「LOGINUSER()」のみ指定できます。ゲストスペースのアプリでは、ユーザー、グループ、関数名のみ指定できます。グループ選択フィールドの場合グループのコードを指定します。組織選択フィールドの場合：組織のコード、関数名を指定します。関数名にはログインユーザーの優先する組織を指定する関数「PRIMARY_ORGANIZATION()」のみ指定できます。 ※削除済みや無効なユーザー、グループ、組織コードは指定することはできません。
properties.（フィールドコード）.defaultNowValue	真偽値または文字列		レコード登録時の日時を初期値にするかどうかを指定します。レコード登録時の日時を初期値にする場合：true レコード登録時の日時を初期値にしない場合（初期設定）：false
properties.（フィールドコード）.options	オブジェクト	条件必須	選択肢の設定を表すオブジェクトです。ラジオボタンなど、選択肢を指定できるフィールドでは、このパラメータは必須です。
properties.（フィールドコード）.options.（選択肢名）	オブジェクト	条件必須	各選択肢の設定を表すオブジェクトです。「（選択肢名）」には追加する選択肢の選択肢名を指定します。「options」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.options.（選択肢名）.label	文字列	条件必須	選択肢名を指定します。「properties.（フィールドコード）.options.（選択肢名）」のキー名と同じ値を指定します。「options」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.options.（選択肢名）.index	数値または文字列	条件必須	選択肢の順番を数値で指定します。指定した数値の昇順で選択肢が並びます。「options」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.align	文字列		選択肢の並びを指定します。横にする場合（初期設定）：HORIZONTAL 縦にする場合：VERTICAL
properties.（フィールドコード）.expression	文字列	条件必須	自動計算式を指定します。計算フィールドでは、このパラメータは必須です。
properties.（フィールドコード）.hideExpression	真偽値または文字列		計算フィールドの計算式を非表示にするかどうかを指定します。非表示にする場合：true 表示する場合（初期設定）：false
properties.（フィールドコード）.digit	真偽値または文字列		数字の桁区切りを表示するかどうかを指定します。表示する場合：true 表示しない場合（初期設定）：false
properties.（フィールドコード）.thumbnailSize	数値または文字列		ピクセル単位でのサムネイル画像の大きさを、50, 150, 250, 500のいずれかで指定します。
properties.（フィールドコード）.protocol	文字列	条件必須	リンクの種類を指定します。リンクフィールドでは、このパラメータは必須です。 Webサイトの場合：WEB 電話番号の場合：CALL メールアドレスの場合：MAIL
properties.（フィールドコード）.format	文字列		計算フィールドの表示形式を指定します。数値（例：1000）：NUMBER（初期設定）数値（例：1,000）：NUMBER_DIGIT 日時（例：2012-08-06 2:03）：DATETIME 日付（例：2012-08-06）：DATE 時刻（例：2:03）：TIME 時間（例：26時間3分）：HOUR_MINUTE 時間（例：1日2時間3分）：DAY_HOUR_MINUTE
properties.（フィールドコード）.displayScale	数値または文字列		小数点以下の表示桁数を指定します。
properties.（フィールドコード）.unit	文字列		単位記号を指定します。
properties.（フィールドコード）.unitPosition	文字列		単位記号の表示位置を指定します。フィールドの前に付ける場合（初期設定）：BEFORE フィールドの後ろに付ける場合：AFTER
properties.（フィールドコード）.entities	配列		ユーザー選択、組織選択、グループ選択フィールドの選択肢を指定します。
properties.（フィールドコード）.entities[].type	文字列	条件必須	選択肢の種類を指定します。「entities」パラメータを指定する場合、このパラメータは必須です。ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION
properties.（フィールドコード）.entities[].code	文字列	条件必須	選択肢のコードを指定します。「entities」パラメータを指定する場合、このパラメータは必須です。ユーザー選択フィールドの場合：ユーザーのログイン名、グループのコード、組織のコードのいずれかを指定します。ゲストスペースのアプリでは、ユーザーかグループのみ指定できます。グループ選択フィールドの場合：グループのコードを指定します。組織選択フィールドの場合：組織のコードを指定します。 ※削除済みや無効なユーザー、グループ、組織コードおよび関数は指定することはできません。
properties.（フィールドコード）.referenceTable	オブジェクト	条件必須	関連レコード一覧フィールドの設定を表すオブジェクトです。関連レコード一覧フィールドでは、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.relatedApp	オブジェクト	条件必須	「参照するアプリ」の設定を表すオブジェクトです。「referenceTable」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.relatedApp.app	数値または文字列	条件必須	「参照するアプリ」に指定するアプリのIDを指定します。「properties.（フィールドコード）.referenceTable.relatedApp.code」パラメータを指定した場合、そちらのパラメータでの指定が優先されます。「referenceTable」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.referenceTable.relatedApp.code	文字列	条件必須	「参照するアプリ」に指定するアプリのコードを指定します。「referenceTable」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.referenceTable.condition	オブジェクト	条件必須	「表示するレコードの条件」の設定を表すオブジェクトです。「referenceTable」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.condition.field	文字列	条件必須	「表示するレコードの条件」に指定する、関連レコード一覧フィールドと同じアプリのフィールドのコードを指定します。「referenceTable」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.condition.relatedField	文字列	条件必須	「表示するレコードの条件」に指定する、関連レコード一覧フィールドが参照するアプリのフィールドのコードを指定します。「referenceTable」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.fliterCond	文字列		「さらに絞り込む条件」の設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.referenceTable.displayFields	配列	条件必須	「表示するフィールド」に指定するフィールドを、フィールドコードの配列で指定します。「referenceTable」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.referenceTable.sort	文字列		レコードのソートの設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.referenceTable.size	数値または文字列		一度に表示する最大レコード数を、5, 10, 20, 30, 40, 50 のいずれかで指定します。パラメータを省略すると、5が指定されます。 ※2020年4月版から 40, 50 を指定できます。
properties.（フィールドコード）.lookup	オブジェクト		ルックアップフィールドの設定を表すオブジェクトです。ルックアップフィールドでは、このパラメータは必須です。
properties.（フィールドコード）.lookup.relatedApp	オブジェクト	条件必須	「関連付けるアプリ」の設定を表すオブジェクトです。「lookup」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.relatedApp.app	数値または文字列	条件必須	関連付けるアプリのIDを指定します。「properties.（フィールドコード）.lookup.relatedApp.code」パラメータを指定した場合、そちらのパラメータでの指定が優先されます。「lookup」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.lookup.relatedApp.code	文字列	条件必須	関連付けるアプリのコードを指定します。「lookup」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.lookup.relatedKeyField	文字列	条件必須	「コピー元のフィールド」に指定するフィールドのコードを指定します。「lookup」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.fieldMappings	配列		「ほかのフィールドのコピー」の設定を表す配列です。
properties.（フィールドコード）.lookup.fieldMappings[].field	文字列	条件必須	「ほかのフィールドのコピー」のコピー先に指定するフィールドのコードを指定します。「lookup.fieldMappings」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.fieldMappings[].relatedField	文字列	条件必須	「ほかのフィールドのコピー」のコピー元に指定するフィールドのコードを指定します。「lookup.fieldMappings」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.lookupPickerFields	配列		「コピー元のレコードの選択時に表示するフィールド」の設定を、フィールドコードの配列で指定します。
properties.（フィールドコード）.lookup.filterCond	文字列		絞り込みの初期設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.lookup.sort	文字列		ソートの初期設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.openGroup	真偽値または文字列		グループ内のフィールドを表示するかどうかを指定します。表示する場合：true 非表示にする場合（初期設定）：false
properties.（フィールドコード）.fields	オブジェクト		テーブル内のフィールドを指定します。パラメータは、「properties」パラメータと同じです。テーブルを設定する場合、このパラメータは必須です。
revision	数値または文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

次のフィールドは、追加も設定の変更もできません。

ステータス
作業者
カテゴリー

リクエストの例

ヘッダ

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

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

フィールドの設定を変更する

フォームに配置したフィールドの設定を変更します。

URI

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

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/form/fields.json

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

指定するパラメータの一覧です。省略したパラメータの設定は変更されません。

パラメータ名	指定する値	必須	説明
app	数値または文字列	必須	アプリのIDを指定します。
properties	オブジェクト	必須	フィールドの設定を表すオブジェクトです。
properties.（フィールドコード）	オブジェクト		各フィールドの設定を表すオブジェクトです。「（フィールドコード）」には更新前のフィールドコードを指定します。フィールドコードを変更したい場合は「properties.（フィールドコード）.code」に、更新後のフィールドコードを指定します。
properties.（フィールドコード）.type	文字列	必須	フィールドの種類を指定します。グループ：GROUP グループ選択：GROUP_SELECT チェックボックス：CHECK_BOX テーブル：SUBTABLE ドロップダウン：DROP_DOWN ユーザー選択：USER_SELECT ラジオボタン：RADIO_BUTTON リッチエディター：RICH_TEXT リンク：LINK ルックアップ：SINGLE_LINE_TEXT、NUMBER または LINK レコード番号：RECORD_NUMBER 関連レコード一覧：REFERENCE_TABLE 計算：CALC 更新者：MODIFIER 更新日時：UPDATED_TIME 作成者：CREATOR 作成日時：CREATED_TIME 時刻：TIME 数値：NUMBER 組織選択：ORGANIZATION_SELECT 添付ファイル：FILE 日時：DATETIME 日付：DATE 複数選択：MULTI_SELECT 文字列（1行）：SINGLE_LINE_TEXT 文字列（複数行）：MULTI_LINE_TEXT ^*：参照先のフィールドの種類を指定します。
properties.（フィールドコード）.code	文字列		フィールドコードを指定します。使用できる文字の制限については、kintoneヘルプを参照してください。
properties.（フィールドコード）.label	文字列		フィールド名を指定します。
properties.（フィールドコード）.noLabel	真偽値または文字列		フィールド名を非表示にするかどうかを指定します。非表示にする場合：true 表示する場合（初期設定）：false
properties.（フィールドコード）.required	真偽値または文字列		入力が必須かどうかを指定します。必須の場合：true 任意の場合（初期設定）：false
properties.（フィールドコード）.unique	真偽値または文字列		重複を禁止するかどうかを指定します。重複を禁止する場合：true 重複を許可する場合（初期設定）：false
properties.（フィールドコード）.maxValue	数値または文字列		最大値を指定します。
properties.（フィールドコード）.minValue	数値または文字列		最小値を指定します。
properties.（フィールドコード）.maxLength	数値または文字列		最大文字数を指定します。
properties.（フィールドコード）.minLength	数値または文字列		最小文字数を指定します。
properties.（フィールドコード）.defaultValue	文字列または配列		初期値を指定します。複数の初期値を設定できるフィールドでは、配列形式で指定します。「defaultNowValue」パラメータを指定した場合、「defaultNowValue」パラメータの指定が優先されます。ユーザー選択、グループ選択、組織選択フィールドの場合codeとtypeを持つオブジェクトの配列を指定します。
properties.（フィールドコード）.defaultValue[].type	文字列	条件必須	ユーザー選択、グループ選択、組織選択フィールドの場合の初期値の種類を指定します。「defaultValue」パラメータを指定する場合、このパラメータは必須です。ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION 関数の場合：FUNCTION
properties.（フィールドコード）.defaultValue[].code	文字列	条件必須	ユーザー選択、グループ選択、組織選択フィールドの場合の初期値のコードを指定します。「defaultValue」パラメータを指定する場合、このパラメータは必須です。ユーザー選択フィールドの場合：ユーザーのログイン名、グループのコード、組織のコード、関数名のいずれかを指定します。関数名にはログインユーザーを指定する関数「LOGINUSER()」のみ指定できます。ゲストスペースのアプリでは、ユーザー、グループ、関数名のみ指定できます。グループ選択フィールドの場合：グループのコードを指定します。組織選択フィールドの場合：組織のコード、関数名を指定します。関数名にはログインユーザーの優先する組織を指定する関数「PRIMARY_ORGANIZATION()」のみ指定できます。 ※削除済みや無効なユーザー、グループ、組織コードは指定することはできません。
properties.（フィールドコード）.defaultNowValue	真偽値または文字列		レコード登録時の日時を初期値にするかどうかを指定します。レコード登録時の日時を初期値にする場合：true レコード登録時の日時を初期値にしない場合（初期設定）：false
properties.（フィールドコード）.options	オブジェクト		選択肢の設定を表すオブジェクトです。
properties.（フィールドコード）.options.（選択肢名）	オブジェクト		各選択肢の設定を表すオブジェクトです。「（選択肢名）」には更新前の選択肢を指定します。存在しない選択肢を「（選択肢名）」に指定した場合：新規の選択肢名として追加します。存在する選択肢を「（選択肢名）」に指定しなかった場合：その選択肢は削除されます。
properties.（フィールドコード）.options.（選択肢名）.label	文字列		選択肢名を指定します。選択肢を追加する場合は「properties.（フィールドコード）.options.（選択肢名）」のキー名と同じ値を指定します。
properties.（フィールドコード）.options.（選択肢名）.index	数値または文字列	条件必須	選択肢の順番を数値で指定します。指定した数値の昇順で選択肢が並びます。「options」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.align	文字列		選択肢の並びを指定します。横にする場合（初期設定）：HORIZONTAL 縦にする場合：VERTICAL
properties.（フィールドコード）.expression	文字列		自動計算式を指定します。
properties.（フィールドコード）.hideExpression	真偽値または文字列		計算フィールドの計算式を非表示にするかどうかを指定します。非表示にする場合：true 表示する場合（初期設定）：false
properties.（フィールドコード）.digit	真偽値または文字列		数字の桁区切りを表示するかどうかを指定します。表示する場合：true 表示しない場合（初期設定）：false
properties.（フィールドコード）.thumbnailSize	数値または文字列		ピクセル単位でのサムネイル画像の大きさを、50, 150, 250, 500のいずれかで指定します。
properties.（フィールドコード）.protocol	文字列		リンクの種類を指定します。 Webサイトの場合：WEB 電話番号の場合：CALL メールアドレスの場合：MAIL
properties.（フィールドコード）.format	文字列		計算フィールドの表示形式を指定します。数値（例：1000）：NUMBER（初期設定）数値（例：1,000）：NUMBER_DIGIT 日時（例：2012-08-06 2:03）：DATETIME 日付（例：2012-08-06）：DATE 時刻（例：2:03）：TIME 時間（例：26時間3分）：HOUR_MINUTE 時間（例：1日2時間3分）：DAY_HOUR_MINUTE
properties.（フィールドコード）.displayScale	数値または文字列		小数点以下の表示桁数を指定します。
properties.（フィールドコード）.unit	文字列		単位記号を指定します。
properties.（フィールドコード）.unitPosition	文字列		単位記号の表示位置を指定します。フィールドの前に付ける場合（初期設定）：BEFORE フィールドの後ろに付ける場合：AFTER
properties.（フィールドコード）.entities	配列		ユーザー選択、組織選択、グループ選択フィールドの選択肢を指定します。
properties.（フィールドコード）.entities[].type	文字列	条件必須	選択肢の種類を指定します。「entities」パラメータを指定する場合、このパラメータは必須です。ユーザーの場合：USER グループの場合：GROUP 組織の場合：ORGANIZATION
properties.（フィールドコード）.entities[].code	文字列	条件必須	選択肢のコードを指定します。「entities」パラメータを指定する場合、このパラメータは必須です。ユーザー選択フィールドの場合：ユーザーのログイン名、グループのコード、組織のコードのいずれかを指定します。ゲストスペースのアプリでは、ユーザーかグループのみ指定できます。グループ選択フィールドの場合：グループのコードを指定します。組織選択フィールドの場合：組織のコードを指定します。
properties.（フィールドコード）.referenceTable	オブジェクト		関連レコード一覧フィールドの設定を表すオブジェクトです。
properties.（フィールドコード）.referenceTable.relatedApp	オブジェクト		「参照するアプリ」の設定を表すオブジェクトです。このパラメータを指定すると、関連レコード一覧フィールドの設定は、「参照するアプリ」以外の設定が初期化されます。
properties.（フィールドコード）.referenceTable.relatedApp.app	数値または文字列	条件必須	「参照するアプリ」に指定するアプリのIDを指定します。「properties.（フィールドコード）.referenceTable.relatedApp.code」パラメータを指定した場合、そちらのパラメータでの指定が優先されます。「relatedApp」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.referenceTable.relatedApp.code	文字列	条件必須	「参照するアプリ」に指定するアプリのコードを指定します。「relatedApp」パラメータを指定する場合、参照するアプリID又は参照するアプリコードのどちらかは必須となります。
properties.（フィールドコード）.referenceTable.condition	オブジェクト		「表示するレコードの条件」の設定を表すオブジェクトです。
properties.（フィールドコード）.referenceTable.condition.field	文字列		「表示するレコードの条件」に指定する、関連レコード一覧フィールドを配置したアプリのフィールドのコードを指定します。
properties.（フィールドコード）.referenceTable.condition.relatedField	文字列		「表示するレコードの条件」に指定する、参照するアプリのフィールドのコードを指定します。
properties.（フィールドコード）.referenceTable.fliterCond	文字列		「さらに絞り込む条件」の設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.referenceTable.displayFields	配列		「表示するフィールド」に指定するフィールドを、フィールドコードの配列で指定します。
properties.（フィールドコード）.referenceTable.sort	文字列		レコードのソートの設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.referenceTable.size	数値または文字列		一度に表示する最大レコード数を、5, 10, 20, 30, 40, 50 のいずれかで指定します。 ※2020年4月版から 40, 50 を指定できます。
properties.（フィールドコード）.lookup	オブジェクト		ルックアップフィールドの設定を表すオブジェクトです。
properties.（フィールドコード）.lookup.fieldMappings	配列		「ほかのフィールドのコピー」の設定を表す配列です。
properties.（フィールドコード）.lookup.fieldMappings.field	文字列	条件必須	「ほかのフィールドのコピー」のコピー先に指定するフィールドのコードを指定します。「lookup.fieldMappings」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.fieldMappings.relatedField	文字列	条件必須	「ほかのフィールドのコピー」のコピー元に指定するフィールドのコードを指定します。「lookup.fieldMappings」パラメータを指定する場合、このパラメータは必須です。
properties.（フィールドコード）.lookup.lookupPickerFields	配列		「コピー元のレコードの選択時に表示するフィールド」の設定を、フィールドコードの配列で指定します。
properties.（フィールドコード）.lookup.filterCond	文字列		絞り込みの初期設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.lookup.sort	文字列		ソートの初期設定をクエリ形式で指定します。クエリ形式については、次のページを参照してください。レコードの一括取得（クエリで条件を指定）
properties.（フィールドコード）.openGroup	真偽値または文字列		グループフィールド内のフィールドを表示するかどうかを指定します。表示する場合：true 非表示にする場合（初期設定）：false
properties.（フィールドコード）.fields	オブジェクト		テーブル内のフィールドを指定します。パラメータは、「properties」パラメータと同じです。
revision	数値または文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

次のフィールドは、追加も設定の変更もできません。

ステータス
作業者
カテゴリー

リクエストの例

ヘッダ

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

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

フィールドを削除する

フォームからフィールドを削除します。グループやテーブルを削除すると、所属するフィールドもまとめて削除されます。

値が自動入力される次のフィールドは、フォーム上から削除されるだけで、データは削除されません。

レコード番号
作成者
更新者
作成日時
更新日時

また、次のフィールドは削除できません。

ステータス
作業者
カテゴリー

URI

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

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/form/fields.json

HTTPメソッド

DELETE

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名

指定する値

必須

説明

app

数値または文字列

必須

アプリのIDを指定します。

fields

配列

必須

削除するフィールドのコードを指定します。

※指定できるフィールドの上限は100件です

revision

数値または文字列

アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。
指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

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

ヘッダ

DELETE /k/v1/preview/app/form/fields.json?app=1&fields[0]=%E6%96%87%E5%AD%97%E5%88%97__1%E8%A1%8C_&fields[1]=%E6%95%B0%E5%80%A4&revision=2 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

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

ヘッダ

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

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

フォームのレイアウトを変更する

URI

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

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/form/layout.json

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

※2020年2月版からAPIトークンを利用してAPIを実行できます。

リクエストパラメータ

指定するパラメータの一覧です。
フォーム上のすべてのフィールドに、レイアウトを指定する必要があります。省略したパラメータの設定は変更されません。

パラメータ名	指定する値	必須	説明
app	数値または文字列	必須	アプリのIDを指定します。
layout	配列	必須	フォームの行ごとのレイアウトを表す配列です。
layout[].type	文字列	必須	行の種類を指定します。標準の行の場合：ROW テーブルの場合：SUBTABLE グループフィールドの場合：GROUP
layout[].code	文字列	条件必須	テーブル、またはグループのコードを指定します。テーブル、グループのいずれでもない標準の行では、このパラメータは不要です。
layout[].fields	配列		行に含まれるフィールドを表す配列です。
layout[].fields[].type	文字列	必須	フィールドの種類を指定します。グループ選択：GROUP_SELECT スペース：SPACER チェックボックス：CHECK_BOX ドロップダウン：DROP_DOWN ユーザー選択：USER_SELECT ラジオボタン：RADIO_BUTTON ラベル：LABEL リッチエディター：RICH_TEXT リンク：LINK ルックアップ：SINGLE_LINE_TEXT、NUMBER または LINK レコード番号：RECORD_NUMBER 関連レコード一覧：REFERENCE_TABLE 計算：CALC 罫線：HR 更新者：MODIFIER 更新日時：UPDATED_TIME 作成者：CREATOR 作成日時：CREATED_TIME 時刻：TIME 数値：NUMBER 組織選択：ORGANIZATION_SELECT 添付ファイル：FILE 日時：DATETIME 日付：DATE 複数選択：MULTI_SELECT 文字列（1行）：SINGLE_LINE_TEXT 文字列（複数行）：MULTI_LINE_TEXT ^*：参照先のフィールドの種類を指定します。
layout[].fields[].code	文字列	条件必須	フィールドコードを指定します。ラベル、スペース、および罫線では、このパラメータは不要です。
layout[].fields[].label	文字列		ラベルフィールドの場合、ラベル名を指定します。
layout[].fields[].elementId	文字列		スペースフィールドの場合、要素IDを指定します。
layout[].fields[].size	オブジェクト		フィールドのサイズを表すオブジェクトです。配置によっては、フィールドが指定したサイズにならない場合があります。
layout[].fields[].size.width	数値または文字列		ピクセル単位でのフィールドの横幅を指定します。次のフィールドでのみ指定できます。文字列（1行）文字列（複数行）リッチエディター数値計算時刻日付日時複数選択ドロップダウンラジオボタンチェックボックス添付ファイルユーザー選択リンクルックアップラベル空白罫線レコード番号作成者作成日時更新者更新日時
layout[].fields[].size.height	数値または文字列		フィールド名を含めた、ピクセル単位でのフィールドの縦幅を指定します。スペースフィールドでのみ指定できます。
layout[].fields[].size.innerHeight	数値または文字列		フィールド名を除いた、ピクセル単位でのフィールドの縦幅を指定します。次のフィールドでのみ指定できます。文字列（複数行）リッチエディター
layout[].layout	配列		グループ内のフィールドのレイアウトを表す配列です。パラメータは、「layout」パラメータと同じです。
revision	数値または文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

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

ボディ

レスポンス

パラメータ

パラメータ名	値の種類	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

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

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Yoshiteru Negishi 2016年10月06日 02:00

`layout[].fields[].size.heigit` は `layout[].fields[].size.height`ではないでしょうか

cybozu Development team 2016年10月07日 00:48

Negishi 様

ご連絡をありがとうございます。タイプミスでした。

以下の通り訂正いたしました。

layout[].fields[].size.height

今後ともどうぞよろしくお願いいたします。

Naoki Takahashi 2018年02月08日 08:43

以下の記載がありますが、「更新日時」フィールド等も「組み込みのフィールドは指定できません。」とのエラーが表示され追加できないようなのですが

こちら、そう行った仕様でしょうか？　であれば、本記事に記載して置いていただけるとありがたいです。

---
次のフィールドは、追加も設定の変更もできません。

ステータス
作業者
カテゴリー

cybozu Development team 2018年02月09日 07:04

Naoki Takahashi様

コメントありがとうございます。developer network事務局です。

「フィールドを追加する」という項目のパラメーター部分に下記を記載させていただいております。
これらのフィールドが指定可能です。
更新日時については、追加いただけません。ご了承ください。

> 次のフィールドは、追加も設定の変更もできません。
> ステータス
> 作業者
> カテゴリー

ご指摘いただいた上記部分に書いている内容は、機能としては存在しているものとなりますが、
フォームの設定画面上にもない項目となり、GUIでもAPIからでもフォームに設定いただけない
ものとなります。
そのため、このような記載をさせていただいており。

わかりにくく申し訳ございません。
よろしくお願い致します。

Naoki Takahashi 2018年02月09日 07:30

cybozu Development team様

別途、「追加も設定の変更もできません」の説明があったため、どうなのかと思いましたが、説明欄に挙げられている項目以外は追加不可ということで、了解しました。

ただ、[共通仕様]->[フィールド形式]のページでは、更新日時は「※4 次のフィールドは、値の取得と登録ができます。値の更新はできません。」

※書いてから気がつきましたが、値としては初期値を登録できるが、フィールドの登録はできないということですね・・・。

Naoki Takahashiにより編集されました 2018年02月09日 07:40

cybozu Development team 2018年02月09日 08:02

Naoki Takahashi様

ご確認いただきありがとうございます。

> ただ、[共通仕様]->[フィールド形式]のページでは、更新日時は「※4 次のフィールドは、値の取得と登録ができます。値の更新はできません。」

はい、上記は値についての仕様となります。
こちらの記事は「フォームの設定の変更」についてになりますので、値ではなく、アプリのフォームに項目のフィールドを追加する場合などの
仕様を記載させていただいております。

よろしくお願い致します。

佐藤 2019年04月02日 11:42

このページのサンプルを元にrevisionを指定していましたが、そのせいでエラーが出ていました。

試してみましたが、revisionは指定しなくても登録できますので、無駄なエラーを防ぐには revision を指定しない方が良いと思いましたので、備忘録として書いておきます。

cybozu Development team 2019年04月04日 06:42

佐藤様

コメントありがとうございます。cybozu developer network 事務局でございます。

各リクエストパラメータは、指定が必須かどうかをそれぞれドキュメント内の表に記載しております。
revisionは記載の通り必須ではございませんので、「revisionをチェックして動作を変える」というような場合にご活用いただければと存じます。

今後ともよろしくお願いいたします。

tsujimotot 2022年04月20日 02:59

選択式フィールドの項目名を本APIで変更した場合、挙動としては「削除→追加」となる認識でよろしいでしょうか。
kintoneの管理画面から項目名を変更した場合、既存レコードの値も新しい選択肢名に自動変更される仕様かと思いますが、APIを使用して更新した場合には実質的に「変更」ができないため、既存レコードの更新は別途必要になるという認識でよろしいでしょうか。

cybozu Development team 2022年04月20日 23:50

tsujimotot 様
お世話になっております。cybozu developer network 事務局でございます。

本APIで選択式フィールドの項目名のみを変更したい場合は、
properties.（フィールドコード）.options.（選択肢名）.label のみを変更することで、
kintone の管理画面から項目名を変えた場合と同じ挙動になります。

例えば、次のように label のみを書き換えると、「sample1」の項目名のみを変えることが出来ます。
管理画面から変更したときと同じように、既に選択済みのレコードに関しても表示が切り替わります。

"options": {
    "sample1(変更前の項目名)": {
        "label": "sample2(変更後の項目名)",
        "index": "0"
    }
}

一方で、次のように properties.（フィールドコード）.options.（選択肢名）も変えた場合は、
記載して頂いたように「sample1」が削除され、「sample2」が追加される挙動になります。

"options": {
    "sample2(変更後の項目名)": {
        "label": "sample2(変更後の項目名)",
        "index": "0"
    }
}

tsujimotot 2022年04月21日 00:46

cybozu developer network 事務局様

そのような仕様だったのですね、承知いたしました。

大変助かりました。ありがとうございました。

Mogami Takafumi 2022年05月13日 05:45

フィールド追加のtype指定に「スペース（フィールド要素としての）」は記載がないようですが、

> 次のフィールドは、追加も設定の変更もできません。
> ステータス
> 作業者
> カテゴリー

こちらにも書かれていません。rest APIでスペースを追加することは可能なのでしょうか、不可能なのでしょうか。
（試したところ追加できなかったので原因を調べているところです）

Mogami Takafumi 2022年05月16日 00:27

五月雨ですみません。

「LABEL（フィールド要素としての）」についても同様に、rest APIで追加可能かどうかを知りたいです。よろしくお願いいたします。

cybozu Development team 2022年05月20日 02:58

Mogami Takafumi 様

お世話になっております。cybozu developer network 事務局です。

フィールドを追加する API（/k/v1/preview/app/form/fields.json [POST]）の
リクエストパラメータ「properties.（フィールドコード）.type」を指定する場合、
フィールドコードを指定する必要がございます。

お問い合わせいただいたスペースフィールドとラベルフィールドは
フィールドコードを指定することができないため、フィールドを追加いただくことができません。

cybozu Development teamにより編集されました 2022年05月20日 02:59

Mogami Takafumi 2022年06月01日 03:09

なるほど了解いたしました。ありがとうございます。

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