6.1.9.11.5. 一覧表示パターン定義情報取得¶
一覧表示パターン定義情報を取得します。
6.1.9.11.5.1. HTTP リクエスト¶
GET /list-display-patterns/{patternId}/detail
6.1.9.11.5.2. パスパラメータ¶
| プロパティ名 | 論理名 | 説明 |
|---|---|---|
| patternId | 一覧表示パターン定義ID |
6.1.9.11.5.3. レスポンスデータ¶
6.1.9.11.5.3.1. JSON¶
{
"defaultFlag": true,
"listPageType": "string",
"localizePatternNameMap": {},
"localizePatternNoteMap": {},
"initSearchColumnId": "string",
"initSearchFutureDays": "string",
"initSearchRetroactiveDays": "string",
"mappingDataList": [
{
"patternMappingTargetCode": "string",
"patternMappingTargetType": "string"
}
],
"selectedListDisplayItemDataList": [
{
"columnClassify": "string",
"columnId": "string",
"columnWidth": "string",
"initSortOrder": "string",
"initSortType": "string",
"noWrapFlag": true
}
]
}
6.1.9.11.5.3.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| defaultFlag | 標準設定フラグ | boolean | 標準未設定 false、標準設定 true |
| listPageType | 一覧画面種別 | string | 「 CodeList 」に対応した値が入ります。 |
| localizePatternNameMap | 一覧表示パターン定義名（多言語） | map<string, string> | ロケールIDをキーとした一覧表示パターン定義の名称が入ります。 |
| localizePatternNoteMap | 一覧表示パターン定義備考（多言語） | map<string, string> | ロケールIDをキーとした一覧表示パターン定義の備考が入ります。 |
| initSearchColumnId | 初期検索一覧表示項目ID | string | 申請日 applyDate、申請基準日 applyBaseDate、到達日 arriveDate、最終処理日 finalProcessDate、案件終了日 matterEndDate |
| initSearchFutureDays | 初期検索将来日数 | string | 初期検索一覧表示項目IDに値が入っている場合にのみ機能します。最大値は 999 です。 |
| initSearchRetroactiveDays | 初期検索遡及日数 | string | 初期検索一覧表示項目IDに値が入っている場合にのみ機能します。最大値は 999 です。 |
| mappingDataList | フローグループ/フローマッピング情報のリスト | array<object> | 一覧表示パターン定義にマッピングされるフローグループ/フロー情報のリストが入ります。 |
| - patternMappingTargetCode | パターンマッピング対象コード | string | フローグループ/フローのIDが入ります。 |
| - patternMappingTargetType | パターンマッピング対象種別 | string | 「 CodeList 」に対応した値が入ります。 |
| selectedListDisplayItemDataList | 選択済み一覧表示項目情報のリスト | array<object> | 一覧画面に表示する一覧表示項目情報のリストが入ります。 |
| - columnClassify | 一覧表示項目種別 | string | 「 CodeList 」に対応した値が入ります。 |
| - columnId | 一覧表示項目ID | string | 「 CodeList 」に対応した値が入ります。 |
| - columnWidth | 一覧表示項目幅 | string | 最大値は 999 です。 |
| - initSortOrder | 初期ソート優先度 | string | 1、2、3 のうちいずれかが入ります。 |
| - initSortType | 初期ソート種別 | string | 「 CodeList 」に対応した値が入ります。
初期ソート優先度が有効な場合にのみ機能します。
|
| - noWrapFlag | 折返し無効フラグ | boolean | 折返す false、折返さない true |
6.1.9.11.5.4. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 6262 | 一覧表示パターン定義情報の取得に失敗しました。一覧表示パターン定義ID : {0} | 管理者に連絡してください。 |
| 1172 | 指定された一覧表示パターン定義IDに紐づく一覧表示パターン定義は存在しません。一覧表示パターン定義ID : {0} | 一覧表示パターン定義IDが正しく入力されているか確認してください。 |
| 1140 | 一覧表示パターン定義ID（patternId）が未指定です。 | 一覧表示パターン定義IDは必須です。 |
| 1150 | 一覧表示パターン定義ID（patternId）に不正な文字が含まれています。patternId : {0} | 一覧表示パターン定義IDには、半角英数字および、一部の記号（ _、- ）のみが使用できます。 |
| 1166 | 一覧表示パターン定義ID（patternId）は20文字以内で指定してください。patternId : {0} | 20文字以内で指定してください。 |