6.1.9.11.1. 一覧表示パターン情報取得¶
一覧表示パターン情報を取得します。
6.1.9.11.1.1. HTTP リクエスト¶
GET /api/workflow/list-display-patterns/{patternId}
6.1.9.11.1.2. パスパラメータ¶
プロパティ名 | 論理名 | 説明 |
---|---|---|
patternId | 一覧表示パターンID |
6.1.9.11.1.3. レスポンスデータ¶
6.1.9.11.1.3.1. JSON¶
{
"listPatternInfo": {
"initSearchConditions": [
{
"columnId": "string",
"formattedValue": "string",
"value": "string"
}
],
"initSortConditions": [
{
"asc": true,
"columnId": "string",
"matterProperty": true
}
],
"listHeaders": [
{
"align": "string",
"caption": "string",
"columnId": "string",
"matterProperty": true,
"width": "string",
"wrap": true
}
]
}
}
6.1.9.11.1.3.2. 詳細¶
プロパティ名 | 論理名 | 型 | 説明 |
---|---|---|---|
listPatternInfo | 一覧表示パターン情報 | object | |
- initSearchConditions | 初期検索条件 | array<object> | 初期検索条件が設定されていない場合は空です。 |
- columnId | 検索対象のカラムID | string | |
- formattedValue | アカウントコンテキストの日付表示形式へ変換した検索値 | string | |
- value | 検索値 | string | |
- initSortConditions | 初期ソート条件のリスト | array<object> | 配列の順番は初期ソート条件の順番です。初期ソート条件が設定されていない場合は空です。 |
- asc | ソート順 | boolean | 昇順 true 、降順 false |
- columnId | ソート対象のカラムID | string | |
- matterProperty | 案件プロパティフラグ | boolean | 案件プロパティのカラム true 、標準のカラム false |
- listHeaders | ヘッダ情報のリスト | array<object> | |
- align | 表示位置 | string | 左寄せ left 、中央 center、右寄せ right |
- caption | キャプション | string | |
- columnId | カラムID | string | |
- matterProperty | 案件プロパティフラグ | boolean | 案件プロパティのカラム true 、標準のカラム false |
- width | 幅 | string | px指定 |
- wrap | 折り返しフラグ | boolean | 折り返す true 、折り返さない false |
6.1.9.11.1.4. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
5024 | 一覧表示パターンIDが未指定です。 | patternId が未指定の場合 |
6233 | 一覧表示パターン情報の取得に失敗しました。 | 一覧表示パターン情報の取得処理に失敗した場合 |
8810 | 指定された一覧表示パターン情報が存在しません。 | 指定された一覧表示パターンIDに一致する情報が存在しない場合 |