intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

6.1.9.11.6. 一覧表示パターン定義情報登録

一覧表示パターン定義情報を登録します。

6.1.9.11.6.1. HTTP リクエスト

POST /list-display-patterns/{patternId}/detail

6.1.9.11.6.2. パスパラメータ

プロパティ名 論理名 説明
patternId 一覧表示パターン定義ID  

6.1.9.11.6.3. リクエストボディ

6.1.9.11.6.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.6.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 123 のうちいずれかが入ります。
- initSortType 初期ソート種別 string
CodeList 」に対応した値が入ります。
初期ソート優先度が有効な場合にのみ機能します。
- noWrapFlag 折返し無効フラグ boolean 折返す false、折返さない true

6.1.9.11.6.4. エラーコード

エラーコード エラーメッセージ 備考
3034 一覧表示パターン定義情報の登録に失敗しました。 管理者に連絡してください。
1171 指定された一覧表示パターン定義IDは、既に使用されています。一覧表示パターン定義ID : {0} 該当の一覧表示パターン定義を削除するか、別のIDを指定してください。
1140 一覧表示パターン定義ID(patternId)が未指定です。 一覧表示パターン定義IDは必須です。
1150 一覧表示パターン定義ID(patternId)に不正な文字が含まれています。patternId : {0} 一覧表示パターン定義IDには、半角英数字および、一部の記号( _- )のみが使用できます。
1166 一覧表示パターン定義ID(patternId)は20文字以内で指定してください。patternId : {0} 20文字以内で指定してください。
6262 一覧表示パターン定義情報の取得に失敗しました。一覧表示パターン定義ID : {0} 管理者に連絡してください。
1139 一覧表示パターン定義情報が未指定です。 一覧表示パターン定義情報は必須です。
1141 一覧表示パターンマッピング対象コード(patternMappingTargetCode)が未指定です。
一覧表示パターンマッピングを登録/更新する際は、一覧表示パターンマッピング対象コードが必須です。
フローグループ/フローのIDを指定してください。
1142 一覧表示パターンマッピング対象種別(patternMappingTargetType)が未指定です。
一覧表示パターンマッピングを登録/更新する際は、一覧表示パターンマッピング対象種別が必須です。
CodeList 」に対応した値を指定してください。
1143 一覧画面種別(listPageType)が未指定です。
一覧画面種別(listPageType)は必須です。
CodeList 」に対応した値を指定してください。
1144 一覧表示パターン定義名(localizePatternNameMap)が1つも指定されていません。
一覧表示パターン定義名は必須です。
キーにはロケールIDを指定してください。
例: "localizePatternNameMap": {"ja": "一覧表示パターン定義名"}
1145 一覧表示パターン定義名(localizePatternNameMap)が未指定です。
一覧表示パターン定義名は必須です。
キーにはロケールIDを指定してください。
例: "localizePatternNameMap": {"ja": "一覧表示パターン定義名"}
1146 ロケールID(localeId)が未指定です。
ロケールIDは必須です。
localizePatternNameMap および、 localizePatternNoteMap のキーとして指定してください。
例: "localizePatternNoteMap": {"ja": "一覧表示パターン定義備考"}
1147 選択済み一覧表示項目(selectedListDisplayItemDataList)が未指定です。 選択済み一覧表示項目は必須です。
1148 一覧表示項目種別(columnClassify)が未指定です。
一覧表示項目種別は必須です。
CodeList 」に対応した値を指定してください。
1149 一覧表示項目ID(columnId)が未指定です。
一覧表示項目IDは必須です。
CodeList 」に対応した値を指定してください。
1151 初期検索将来日数(initSearchFutureDays)に不正な文字が含まれています。initSearchFutureDays : {0} 初期検索将来日数は、数値で指定してください。
1152 初期検索遡及日数(initSearchRetroactiveDays)に不正な文字が含まれています。initSearchRetroactiveDays : {0} 初期検索遡及日数は、数値で指定してください。
1153 一覧表示項目幅(columnWidth)に不正な文字が含まれています。columnWidth : {0} 一覧表示項目幅は、数値で指定してください。
1156 初期ソート優先度(initSortOrder)に設定不可能な値が指定されています。initSortOrder : {0} 123 のうちいずれかを指定してください。
1158 一覧表示パターンマッピング対象コード(patternMappingTargetCode)に存在しない値が指定されています。patternMappingTargetCode : {0} フローグループ/フローのIDを指定してください。
1159 一覧表示パターンマッピング対象種別(patternMappingTargetType)に設定不可能な値が指定されています。patternMappingTargetType : {0} CodeList 」に対応した値を指定してください。
1160 一覧画面種別(listPageType)に存在しない値が指定されています。listPageType : {0} CodeList 」に対応した値を指定してください。
1161 ロケールID(localeId)に存在しない値が指定されています。localeId : {0}
テナント環境に登録されているロケールのIDを指定してください。
例: jaenzh_CN
1162 初期検索一覧表示項目ID(initSearchColumnId)に設定不可能な一覧表示項目IDが指定されています。initSearchColumnId : {0} applyDateapplyBaseDatearriveDatefinalProcessDatematterEndDate のうちいずれかを指定してください。
1163 一覧表示項目種別(columnClassify)に設定不可能な値が指定されています。columnClassify : {0} CodeList 」に対応した値を指定してください。
1164 一覧表示項目ID(columnId)に存在しない値が指定されています。columnId : {0} CodeList 」に対応した値を指定してください。
1165 指定された一覧表示項目幅(columnWidth)が入力可能な範囲を超えています。columnWidth : {0} 一覧表示項目幅に指定できる最大値は 999 です。
1167 指定された一覧表示パターン定義名(localizePatternNameMap)が入力可能文字数を超えています。localizePatternNameMap : {0} 50文字以内を目安に指定してください。
1168 指定された一覧表示パターン定義の備考(localizePatternNoteMap)が入力可能文字数を超えています。localizePatternNoteMap : {0} 500文字以内を目安に指定してください。
1169 指定された初期検索将来日数(initSearchFutureDays)が入力可能な範囲を超えています。initSearchFutureDays : {0} 初期検索将来日数に指定できる最大値は 999 です。
1170 指定された初期検索遡及日数(initSearchRetroactiveDays)が入力可能な範囲を超えています。initSearchRetroactiveDays : {0} 初期検索遡及日数に指定できる最大値は 999 です。
1174 指定された一覧画面種別(listPageType)では、指定された一覧表示項目ID(columnId)は使用できません。columnId : {0} 一覧画面種別と対応した一覧表示項目を確認してください。
1175 指定された一覧画面種別(listPageType)では、指定された一覧表示項目ID(initSearchColumnId)は使用できません。または、指定された一覧表示項目IDは存在しません。initSearchColumnId : {0}
applyDateapplyBaseDatearriveDatefinalProcessDatematterEndDate のうちいずれかを指定してください。
また、一覧画面種別と対応した一覧表示項目を確認してください。
6264 一覧表示パターンマッピング対象コード(patternMappingTargetCode)によるフローグループ/フローの存在確認に失敗しました。patternMappingTargetCode : {0} 管理者に連絡してください。
1176 一覧表示項目ID(columnId)に指定された値が重複しています。columnId : {0} 同一の一覧表示項目は複数登録できません。
1177 初期ソート優先度(initSortOrder)に指定された値が重複しています。initSortOrder : {0} 複数の一覧表示項目に同一の初期ソート優先度は指定できません。
1178 初期ソート優先度(initSortOrder)に指定された値が不足しています。優先度「{0}」が含まれているため、最低でも{0}つ指定する必要があります。 最も優先したいものを 1 として、順番に指定してください。
1179 初期ソート条件を設定不可能な一覧表示項目に、初期ソート条件が指定されています。columnId : {0} 該当の一覧表示項目には初期ソート条件を設定できません。