申請フォームを構成している項目を取得する

Garoon APIドキュメント

申請フォームを構成している項目を取得する

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

申請フォームを構成している項目を取得する

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

申請フォームを構成している項目の一覧を取得します。

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/workflow/admin/forms/WORKFLOW_FORM_ID

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
INSTALL_IDENTIFER：Garoonのインストール識別子

Windows環境: http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/workflow/admin/forms/WORKFLOW_FORM_ID
Linux環境: http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/workflow/admin/forms/WORKFLOW_FORM_ID

パスパラメーター

パラメーター名	説明
WORKFLOW_FORM_ID	取得する申請フォームのID

HTTPメソッド

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

GET

利用できるバージョン

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

クラウド版Garoon
パッケージ版Garoon 5.15以降

必要なアクセス権

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

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

cybozu.com共通管理者
ワークフローのアプリケーション管理者権限

リクエスト

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

パラメーター

なし

リクエストの例

URL

https://sample.cybozu.com/g/api/v1/workflow/admin/forms/1

ヘッダー

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

レスポンス

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

プロパティ

申請フォーム項目のタイプによって、返る値が異なります。

基本プロパティ

プロパティ名	型	説明
form.id	文字列	申請フォームのID
form.name	文字列	申請フォーム名
form.items	オブジェクト	申請フォーム項目の内容のオブジェクト items.typeごとに内容が異なります。詳細は別表に記載しています。
form.items.type	文字列	申請フォームの項目のタイプタイプによって、次のいずれかの値が返ります。 `SINGLE_LINE_TEXT`：文字列（1行） `MULTI_LINE_TEXT`：文字列（複数行） `DROP_DOWN`：メニュー `RADIO_BUTTON`：ラジオボタン `CHECK_BOX`：チェックボックス `NUMBER`：数値 `CALC`：自動計算 `DATE`：日付（日付のみ） `DATETIME`：日付（日付と時刻） `FILE`：ファイル添付 `ROUTE_TRAVEL_EXPENSE`：路線ナビ連携 `BLANK_LINE`：空行

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

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.entryFieldWidth	数値	申請フォームの「入力幅」の値
form.items.maximumInputCharacters	数値	申請フォームの「最大入力文字数」の値
form.items.characterRestriction	文字列	申請フォームの「入力文字制限」次のいずれかの値が返ります。 `UNRESTRICTED`：制限なし `MULTI_BYTE_CHARACTERS_ONLY`：全角のみ `SINGLE_BYTE_CHARACTERS_ONLY`：半角のみ
form.items.initialValue	オブジェクト	申請フォームの「初期値」
form.items.initialValue.type	文字列	申請フォームの「初期値」の設定次のいずれかの値が返ります。 `STANDARD`：直接入力 `OBTAIN_FROM_USER_INFORMATION`：ユーザー情報
form.items.initialValue.value	文字列	申請フォームの「初期値」の値次のいずれかの値が返ります。直接入力の場合入力されている文字列が返ります。ユーザー情報の場合 `ID`：GaroonユーザーID `NAME`：ユーザー名前 `LOGIN_NAME`：ユーザーログイン名 `PRONUNCIATION`：ユーザーよみ `E_MAIL`：ユーザーE-Mail `CONTACT`：ユーザー連絡先 `URL`：ユーザーURL `NOTES`：ユーザーメモ `POSITION`：ユーザー役職 `{customItemName}`：ユーザー（カスタマイズ項目の項目名）
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容
form.items.standardItem	真偽値	「申請フォームの項目一覧」で「項目タイプ」に「（標準項目）」の記載がある場合は、「true」が返ります。

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

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.size	オブジェクト	申請フォームの「サイズ」
form.items.size.characters	数値	申請フォームの「サイズ」の「桁」の値
form.items.size.lines	数値	申請フォームの「サイズ」の「行」の値
form.items.initialValue	オブジェクト	申請フォームの「初期値」
form.items.initialValue.value	文字列	申請フォームの「初期値」に入力されている内容
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置： `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

メニューのプロパティ

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.menuItems	オブジェクト	申請フォームの「メニュー項目」
form.items.menuItems.type	文字列	申請フォームの「メニュー項目」の設定次のいずれかの値が返ります。 `FULL_MENU`：直接入力 `ORGANIZATION`：所属する組織
form.items.menuItems.value	配列（文字列）	申請フォームの「メニュー項目」で設定しているメニュー名申請フォームの「メニュー項目」で「所属する組織」を選択している場合は、空の配列が返ります。
form.items.menuItems.initialValue	文字列	申請フォームの「メニュー項目」の初期値
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

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

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.options	オブジェクト	申請フォームの「ラジオ項目」
form.items.options.value	配列（文字列）	申請フォームの「ラジオ項目」で設定している項目名
form.items.options.initialValue	文字列	申請フォームの「初期値」
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

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

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.initialValue	真偽値	申請フォームの「初期値」が選択されている場合は、「true」が返ります。
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

数値のプロパティ

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.limits	オブジェクト	申請フォームの「入力値制限」
form.items.limits.type	文字列	申請フォームの「入力値制限」の設定次のいずれかの値が返ります。 `UNRESTRICTED`：NONE `RESTRICTED`：制限あり
form.items.limits.value	オブジェクト	申請フォームの「入力値制限」の値次のいずれかの値が返ります。空のオブジェクトが：制限なし最大値と最小値が含まれるオブジェクト：制限あり
form.items.limits.max	文字列	申請フォームの「入力値制限」の「最大値」
form.items.limits.min	文字列	申請フォームの「入力値制限」の「最小値」
form.items.initialValue	文字列	申請フォームの「初期値」
form.items.significantFigures	数値	申請フォームの「小数点次の有効な桁数」
form.items.negativeValueSign	文字列	申請フォームの「マイナス値の表示方法」次のいずれかの値が返ります。 `0`：-1234 `1`：▲1234 `2`：△1234
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.isRightAlign	真偽値	申請フォームの「表示」で、「右寄せで表示する」が選択されている場合は、「true」が返ります。
form.items.displayThousandsSeparator	真偽値	申請フォームの「表示」で、「桁区切りを表示する」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

自動計算のプロパティ

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.significantFigures	数値	申請フォームの「小数点次の有効な桁数」
form.items.negativeValueSign	文字列	申請フォームの「マイナス値の表示方法」次のいずれかの値が返ります。 `0`：-1234 `1`：▲1234 `2`：△1234
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.calculation	オブジェクト	申請フォームの「計算内容」
form.items.calculation.type	文字列	申請フォームの「計算内容」次のいずれかの値が返ります。 ARITHMETIC：四則演算 SIMPLE_SUM：合計
form.items.calculation.calcSign	文字列	「計算内容」で「四則演算」を選択している場合に、設定している四則演算記号
form.items.calculation.num1 form.items.calculation.num2	オブジェクト	「計算内容」で「四則演算」を選択している場合に返るオブジェクト左側のフォームの内容がnum1、右側のフォームの内容がnum2です。
form.items.calculation.num1.type form.items.calculation.num2.type	文字列	「計算内容」で「四則演算」を選択している場合の、ドロップダウンリストの内容次のいずれかの値が返ります。 `CONSTANT`：定数 `ITEM`：項目
form.items.calculation.num1.code form.items.calculation.num2.code	文字列	「計算内容」で「四則演算」を選択し、ドロップダウンリストで「項目」を設定している場合の、項目コード
form.items.calculation.num1.value form.items.calculation.num2.value	文字列	「計算内容」で「四則演算」を選択している場合に、設定している定数
form.items.calculation.sumItems	配列	「計算内容」で「合計」を選択している場合に返る配列設定している項目の項目コードが、配列に入ります。
form.items.isRightAlign	真偽値	申請フォームの「表示」で、「右寄せで表示する」が選択されている場合は、「true」が返ります。
form.items.displayThousandsSeparator	真偽値	申請フォームの「表示」で、「桁区切りを表示する」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

日付のプロパティ

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.initialValue	オブジェクト	申請フォームの「初期値」
form.items.initialValue.type	文字列	申請フォームの「初期値」で設定している項目次のいずれかの値が返ります。 `CURRENT`：入力時の現在日付にする、または入力時の現在日時にする `SPECIFIC_DATE`：特定の日付、または特定の日時 `UNSPECIFIED`：指定しない（空欄）
form.items.initialValue.date	文字列	申請フォームの「初期値」で「特定の日付」または「特定の日時」を選択している場合に、設定している日付
form.items.initialValue.time	文字列	申請フォームの「初期値」で「特定の日時」を選択している場合に、設定している時刻
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

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

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、`$[item_id]`という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.maxNumberOfFiles	数値	申請フォームの「最大ファイル数」
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.showImageWithBodyText	真偽値	申請フォームの「表示」で、「イメージを本文と一緒に表示する」が選択されている場合は、「true」が返ります。
form.items.resizeImageWidth	オブジェクト	申請フォームの「表示」で、「イメージを縮小する」が選択されている場合に返るオブジェクト
form.items.resizeImageWidth.width	文字列	申請フォームの「表示」で、「イメージを縮小する」の「幅」に入力されている値
form.items.resizeImageWidth.height	文字列	申請フォームの「表示」で、「イメージを縮小する」の「高さ」に入力されている値
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

路線ナビ連携のプロパティ

プロパティ名	型	説明
form.items.code	文字列	申請フォームの「項目コード」項目コードが設定されていない場合は、「$[item_id]」という形式の値が返ります。
form.items.name	文字列	申請フォームの「項目名」
form.items.information	文字列	申請フォームの「取り込む情報」次のいずれかの値が返ります。 `ROUTE_TRAVEL_EXPENSE`：路線/運賃 `ROUTE`：経路 `TRAVEL_EXPENSE`：運賃
form.items.description	オブジェクト	申請フォームの「説明」
form.items.description.type	文字列	申請フォームの「説明」のテキストエリアの設定次のいずれかの値が返ります。 `PLAIN_TEXT`：テキスト `RICH_TEXT`：書式編集
form.items.description.value	文字列	申請フォームの「説明」に入力されている内容
form.items.description.showDescriptionWithIcon	真偽値	申請フォームの「説明」で、「アイコンで表示する」が選択されている場合は、「true」が返ります。
form.items.required	真偽値	申請フォームの「項目の条件」で、「必須項目にする」が選択されている場合は、「true」が返ります。
form.items.label	オブジェクト	申請フォームの「入力欄の前/後の文字」
form.items.label.type	文字列	申請フォームの「入力欄の前/後の文字」の位置次のいずれかの値が返ります。 `DO_NOT_USE`：配置しない `BEFORE`：前に配置 `AFTER`：後に配置
form.items.label.value	文字列	申請フォームの「入力欄の前/後の文字」に入力されている内容
form.items.rowSharing	オブジェクト	申請フォームの「右隣への配置」
form.items.rowSharing.isShared	真偽値	申請フォームの「右隣への配置」で、「直前の項目に続けて、右隣に配置する。」が選択されている場合は、「true」が返ります。
form.items.rowSharing.separator	文字列	申請フォームの「右隣への配置」の、「セパレーター」に入力されている内容

レスポンスの例

  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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290


{
  "form": {
    "id": "123",
    "name": "申請フォーム名",
    "items": [
      {
        "type": "SINGLE_LINE_TEXT",
        "code": "0",
        "name": "文字列（1行）の項目名",
        "entryFieldWidth": 120,
        "maximumInputCharacters": 120,
        "characterRestriction": "MULTI_BYTE_CHARACTERS_ONLY",
        "initialValue": {
          "type": "STANDARD",
          "value": "test"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "文字列（1行）の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "label": {
          "type": "BEFORE",
          "value": "テキスト："
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        },
        "standardItem": true
      },
      {
        "type": "MULTI_LINE_TEXT",
        "code": "1",
        "name": "文字列（複数行）の項目名",
        "size": {
          "characters": 40,
          "line": 3
        },
        "initialValue": {
          "value": "test"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "文字列（複数行）の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": "false,",
        "label": {
          "type": "BEFORE",
          "value": "テキスト："
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "DROP_DOWN",
        "code": "drop_down_code",
        "name": "メニューの項目名",
        "menuItems": {
          "type": "FULL_MENU",
          "value": ["りんご", "バナナ", "ぶどう"],
          "initialValue": "りんご"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "メニューの説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "label": {
          "type": "BEFORE",
          "value": "果物："
        },
        "rowSharing": {
          "isShared": "true",
          "separator": "@"
        }
      },
      {
        "type": "RADIO_BUTTON",
        "code": "radio_button_code",
        "name": "ラジオボタンの項目名",
        "options": {
          "value": ["りんご", "バナナ", "ぶどう"],
          "initialValue": "りんご"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "ラジオボタンの説明です。",
          "showDescriptionWithIcon": false
        },
        "required": false,
        "label": {
          "type": "BEFORE",
          "value": "果物："
        },
        "rowSharing": {
          "isShared": true,
          "separator": "@"
        }
      },
      {
        "type": "CHECK_BOX",
        "code": "check_box_code",
        "name": "必要",
        "initialValue": true,
        "description": {
          "type": "PLAIN_TEXT",
          "value": "チェックボックスの説明です。",
          "showDescriptionWithIcon": true
        },
        "label": {
          "type": "BEFORE",
          "value": "果物が必要な場合はチェック："
        },
        "rowsharing": {
          "isShared": true,
          "separator": "@"
        }
      },
      {
        "type": "NUMBER",
        "code": "number_code",
        "name": "数値の項目名",
        "limits": {
          "type": "RESTRICTED",
          "value": {
            "max": "100",
            "min": "10"
          }
        },
        "initialValue": "10",
        "significantFigures": 3,
        "negativeValueSign": "0",
        "description": {
          "type": "PLAIN_TEXT",
          "value": "数値の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "isRightAlign": true,
        "displayThousandsSeparator": true,
        "label": {
          "type": "BEFORE",
          "value": "値段："
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "CALC",
        "code": "calculation_code",
        "name": "自動計算の項目名",
        "significantFigures": 3,
        "negativeValueSign": "0",
        "description": {
          "type": "PLAIN_TEXT",
          "value": "自動計算の説明です。",
          "showDescriptionWithIcon": true
        },
        "calcSign": "*",
        "calculation": {
          "type": "SIMPLE_SUM",
          "num1": {
            "type": "ITEM",
            "code": "number_code",
            "value": "100"
          },
          "num2": {
            "type": "CONSTANT",
            "code": "",
            "value": "1.08"
          }
        },
        "isRightAlign": true,
        "displayThousandsSeparator": true,
        "hideDisplayCalculation": true,
        "label": {
          "type": "BEFORE",
          "value": "税込み価格:"
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "DATE",
        "code": "date_code",
        "name": "日付（日付のみ）の項目名",
        "initialValue": {
          "type": "SPECIFIC_DATE",
          "date": "2022-02-13"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "日付の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "label": {
          "type": "BEFORE",
          "value": "購入日:"
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "DATETIME",
        "code": "datetime_code",
        "name": "日付（日付と時刻）の項目名",
        "initialValue": {
          "type": "SPECIFIC_DATE",
          "date": "2022-02-13",
          "time": "09:05"
        },
        "description": {
          "type": "PLAIN_TEXT",
          "value": "日付と時刻の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "label": {
          "type": "BEFORE",
          "value": "購入日時："
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "FILE",
        "code": "file_code",
        "name": "ファイル添付の項目名",
        "maxNumberOfFiles": 3,
        "description": {
          "type": "PLAIN_TEXT",
          "value": "ファイル添付の項目名です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "showImageWithBodyText": true,
        "resizeImageWidth": {
          "width": "50",
          "height": "50"
        },
        "label": {
          "type": "BEFORE",
          "value": "Outline:"
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "ROUTE_NAVI",
        "code": "route_navi_code",
        "name": "路線ナビ連携の項目名",
        "information": "ROUTE_TRAVEL_EXPENSE",
        "description": {
          "type": "PLAIN_TEXT",
          "value": "路線ナビ連携の説明です。",
          "showDescriptionWithIcon": true
        },
        "required": true,
        "label": {
          "type": "BEFORE",
          "value": "路線ナビ連携："
        },
        "rowSharing": {
          "isShared": false,
          "separator": ""
        }
      },
      {
        "type": "BLANK_LINE"
      }
    ]
  }
}

サンプルコード

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

curlを使ったリクエスト

1
2


curl -X GET 'https://sample.cybozu.com/g/api/v1/workflow/admin/forms/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

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

1

await garoon.api('/api/v1/workflow/admin/forms/1', 'GET', {});

Garoon APIドキュメント

申請フォームを構成している項目を取得する

目次

申請フォームを構成している項目を取得する

URL

クラウド版

パッケージ版

パスパラメーター

HTTPメソッド

利用できるバージョン

必要なアクセス権

リクエスト

パラメーター

リクエストの例

URL

ヘッダー

レスポンス

プロパティ

基本プロパティ

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

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

メニューのプロパティ

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

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

数値のプロパティ

自動計算のプロパティ

日付のプロパティ

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

路線ナビ連携のプロパティ

レスポンスの例

サンプルコード

curlを使ったリクエスト

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