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

6.1.9.11.3. 一覧表示項目情報リスト取得

一覧表示項目情報をリスト取得します。

6.1.9.11.3.1. HTTP リクエスト

GET /api/workflow/list-display-patterns/list-display-items/{listPageType}

6.1.9.11.3.2. パスパラメータ

プロパティ名 論理名 説明
listPageType 一覧画面種別 CodeList 」に対応した値を指定してください。

6.1.9.11.3.3. レスポンスデータ

6.1.9.11.3.3.1. JSON

[
  {
    "align": "string",
    "calendarFlag": true,
    "caption": "string",
    "columnClassify": "string",
    "columnId": "string",
    "commaSeparated": true,
    "matterPropertyType": "string",
    "sortFlag": true,
    "sortKey": "string"
  }
]

6.1.9.11.3.3.2. 詳細

プロパティ名 論理名 説明
align キャプション/アイコン表示位置 string 左寄せ left、中央 center、右寄せ right
calendarFlag カレンダー表示フラグ boolean
非表示 false、表示 true
一覧表示項目種別が案件プロパティの項目の場合にのみ機能します。
案件プロパティ定義の「カレンダー表示」設定と対応します。
caption キャプション string  
columnClassify 一覧表示項目種別 string CodeList 」に対応した値が入ります。
columnId 一覧表示項目ID string CodeList 」に対応した値が入ります。
commaSeparated カンマ区切り boolean
カンマ区切りで表示しない false、カンマ区切りで表示する true
一覧表示項目種別が案件プロパティの項目でかつ、案件プロパティ種別が数値の場合にのみ機能します。
案件プロパティ定義の「カンマ区切りで表示する」設定と対応します。
matterPropertyType 案件プロパティ種別 string
CodeList 」に対応した値が入ります。
一覧表示項目種別が案件プロパティの項目の場合にのみ機能します。
sortFlag ソート可否 boolean ソート不可 false、ソート可能 true
sortKey ソートキー(表示順) string  

6.1.9.11.3.4. エラーコード

エラーコード エラーメッセージ 備考
6261 一覧表示項目情報の取得に失敗しました。一覧画面種別 : {0} 一覧表示項目情報の取得に失敗した場合
1144 一覧画面種別(listPageType)が未指定です。
一覧画面種別 listPageType が未指定の場合
CodeList 」に対応した値を指定してください。
1162 一覧画面種別(listPageType)に存在しない値が指定されています。listPageType : {0}
一覧画面種別 listPageType に存在しない値が指定された場合
CodeList 」に対応した値を指定してください。