6.1.9.11.4. 一覧表示パターン定義情報リスト取得¶
一覧表示パターン定義情報をリスト取得します。
6.1.9.11.4.1. HTTP リクエスト¶
POST /api/workflow/list-display-patterns
6.1.9.11.4.2. リクエストボディ¶
6.1.9.11.4.2.1. JSON¶
{
"count": "string",
"listPageType": "string",
"offset": "string",
"orderByConditionList": [
{
"sortType": "string",
"sortTarget": "string"
}
],
"searchTarget": "string",
"searchValue": "string"
}
6.1.9.11.4.2.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| count | 取得件数 | string | |
| listPageType | 一覧画面種別 | string | 「 CodeList 」に対応した値を指定してください。 |
| offset | 取得開始位置 | string | |
| orderByConditionList | ソート条件のリスト | array<object> | |
| - sortType | ソート種別 | string | 「 CodeList 」に対応した値を指定してください。
DESC または、 desc 以外の文字列を指定した場合は昇順として認識します。
|
| - sortTarget | ソート対象 | string | テーブル imw_m_list_pattern の各列名を指定できます。
例: 一覧表示パターン定義ID patternId、一覧表示パターン定義名 patternName
|
| searchTarget | 検索対象 | string | 一覧表示パターン定義ID patternId、一覧表示パターン定義名 patternName、一覧表示パターン定義備考 note |
| searchValue | 検索値 | string |
6.1.9.11.4.3. レスポンスデータ¶
6.1.9.11.4.3.1. JSON¶
[
{
"defaultFlag": true,
"listPageType": "string",
"localizePatternNameMap": {},
"localizePatternNoteMap": {},
"mappingDataList": [
{
"patternMappingTargetCode": "string",
"patternMappingTargetType": "string",
"patternMappingTargetName": "string"
}
],
"patternId": "string"
}
]
6.1.9.11.4.3.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| defaultFlag | 標準設定フラグ | boolean | 標準未設定 false、標準設定 true |
| listPageType | 一覧画面種別 | string | 「 CodeList 」に対応した値が入ります。 |
| localizePatternNameMap | 一覧表示パターン定義名（多言語） | map<string, string> | ロケールIDをキーとした一覧表示パターン定義の名称が入ります。 |
| localizePatternNoteMap | 一覧表示パターン定義備考（多言語） | map<string, string> | ロケールIDをキーとした一覧表示パターン定義の備考が入ります。 |
| mappingDataList | フローグループ/フローマッピング情報のリスト | array<object> | 一覧表示パターン定義にマッピングされているフローグループ/フロー情報のリストが入ります。 |
| - patternMappingTargetCode | パターンマッピング対象コード | string | フローIDまたは、フローグループIDが入ります。 |
| - patternMappingTargetType | パターンマッピング対象種別 | string | 「 CodeList 」に対応した値が入ります。 |
| - patternMappingTargetName | パターンマッピング対象名 | string | フローグループ/フローの名称が入ります。 |
| patternId | 一覧表示パターン定義ID | string |
6.1.9.11.4.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 6262 | 一覧表示パターン定義情報の取得に失敗しました。一覧表示パターン定義ID : {0} | 管理者に連絡してください。 |
| 6263 | 一覧表示パターン定義情報のリスト取得に失敗しました。 | 管理者に連絡してください。 |
| 1154 | 取得開始位置（offset）は数値で指定してください。offset : {0} | 取得開始位置は、数値で指定してください。 |
| 1155 | 取得件数（count）は数値で指定してください。count : {0} | 取得件数は、数値で指定してください。 |
| 1157 | 検索/絞込みの対象（searchTarget）に設定不可能な値が指定されています。searchTarget : {0} | patternId、patternName、note のうちいずれかを指定してください。 |
| 1160 | 一覧画面種別（listPageType）に存在しない値が指定されています。listPageType : {0} | 「 CodeList 」に対応した値を指定してください。 |
| 1140 | 一覧表示パターン定義ID（patternId）が未指定です。 | 一覧表示パターン定義IDは必須です。 |
| 1150 | 一覧表示パターン定義ID（patternId）に不正な文字が含まれています。patternId : {0} | 一覧表示パターン定義IDには、半角英数字および、一部の記号（ _、- ）のみが使用できます。 |
| 1166 | 一覧表示パターン定義ID（patternId）は20文字以内で指定してください。patternId : {0} | 20文字以内で指定してください。 |