4.2. 出力値¶
IM-FormaDesigner の画面アイテムの入力値に不備がある場合、各アクションの出力値に加えて、エラー詳細を出力します。
項目名 | 型 | 説明 |
---|---|---|
errorCode | 文字列 | エラーコードを返却 |
localizedErrorMessage | 文字列 | 入力値に不備があるすべてのアイテムのエラーメッセージを返却 |
errorDetails | オブジェクト | エラー詳細を返却
下記参照
|
4.2.1. エラー詳細(入力アイテム)¶
項目名 | 型 | 説明 |
---|---|---|
inputId | 文字列 | フィールド識別IDを返却 |
itemType | 文字列 | アイテム種別を返却 |
message | 文字列 | 入力アイテム毎のエラーメッセージを返却 |
- 入力アイテムの入力値に不備があった際に返却されるJSONの一例です。
"data": {
"localizedErrorMessage": "「文字列1」を入力してください。 「文字列2」を入力してください。",
"errorCode": "9010",
"errorDetails": [
{
"inputId": "textbox1",
"itemType": "product_72_textbox",
"message": "「文字列1」を入力してください。"
},
{
"inputId": "textbox2",
"itemType": "product_72_textbox",
"message": "「文字列2」を入力してください。"
}
]
}
4.2.2. エラー詳細(テーブル系アイテム)¶
項目名 | 型 | 説明 |
---|---|---|
inputId | 文字列 | フィールド識別IDを返却 |
itemType | 文字列 | 「明細テーブル」の場合、列のタイプ型を返却
「グリッドテーブル」の場合、列のデータ型を返却
|
index | 文字列 | エラーが発生した行数を返却 |
- 「明細テーブル」アイテムの入力値に不備があった際に返却されるJSONの一例です。
"data": {
"localizedErrorMessage": "「文字列」を入力してください。[ 1行目 ]\n「数字」を入力してください。[ 1行目 ]\n「数字」を入力してください。[ 2行目 ]",
"errorCode": "9010",
"errorDetails": [
{
"inputId": "tb1_textbox1",
"itemType": "textbox",
"index": "0"
},
{
"inputId": "tb1_number1",
"itemType": "number",
"index": "0"
},
{
"inputId": "tb1_number1",
"itemType": "number",
"index": "1"
}
]
}
- 「グリッドテーブル」アイテムの入力値に不備があった際に返却されるJSONの一例です。
"data": {
"localizedErrorMessage": "「文字列」を入力してください。\n「数値」を入力してください。",
"errorCode": "9010",
"errorDetails": [
{
"inputId": "gt1_textbox1",
"itemType": "0",
"index": "0"
},
{
"inputId": "gt1_number1",
"itemType": "1",
"index": "0"
}
]
}
コラム
「明細テーブル」のタイプ型は、以下のタイプ型と紐づいた文字列を返却します。
タイプ型 返却値 文字列 textbox 数値 number 日付 calendar 隠しパラメータ hidden 関数 func 一覧選択 itemSelect ラジオボタン radio セレクトボックス selectbox
コラム
「グリッドテーブル」のデータ型は、以下のデータ型と紐づいた文字列を返却します。
データ型 返却値 文字列型 0 数値型 1 日付型 2 タイムスタンプ型 9
4.2.3. エラー詳細(スプレッドシート)¶
項目名 | 型 | 説明 |
---|---|---|
inputId | 文字列 | フィールド識別IDを返却 |
itemType | 文字列 | アイテム種別を返却 |
message | 文字列 | スプレッドシートアイテム毎のエラーメッセージを返却 |
index | 文字列 | エラーが発生した行数を返却
テーブルのみ返却
|
- 「スプレッドシート」アイテムの入力値に不備があった際に返却されるJSONの一例です。
"data": {
"localizedErrorMessage": "入力内容に誤りがあります。[スプレッドシート1]\n入力内容に誤りがあります。[スプレッドシート2]",
"errorCode": "9010",
"errorDetails": [
{
"inputId": "spr1_cell1",
"itemType": "product_80_spreadsheet",
"message": "入力内容に誤りがあります。[スプレッドシート1]"
},
{
"inputId": "spr2_tb1_col1",
"itemType": "product_80_spreadsheet",
"message": "入力内容に誤りがあります。[スプレッドシート2]",
"index": "0"
}
]
}