6.1.9.10.13. フローグループ情報取得¶
フローグループ情報を取得します。
6.1.9.10.13.1. HTTP リクエスト¶
GET /api/workflow/flow-groups/{flowGroupId}/data
6.1.9.10.13.2. パスパラメータ¶
| プロパティ名 | 論理名 | 説明 |
|---|---|---|
| flowGroupId | フローグループID |
6.1.9.10.13.3. クエリパラメータ¶
| プロパティ名 | 論理名 | 型 | 必須 | 説明 |
|---|---|---|---|---|
| listPageType | 一覧画面種別 | string | - | 「 CodeList 」 のコード値を指定してください。 |
6.1.9.10.13.4. レスポンスデータ¶
6.1.9.10.13.4.1. JSON¶
{
"data": {
"flowGroupId": "string",
"flowGroupName": "string",
"listDisplayPatternId": "string",
"note": "string",
"parentFlowGroups": [
{
"flowGroupId": "string",
"flowGroupName": "string"
}
]
}
}
6.1.9.10.13.4.2. 詳細¶
| プロパティ名 | 論理名 | 型 | 説明 |
|---|---|---|---|
| flowGroupId | フローグループID | string | |
| flowGroupName | フローグループ名 | string | |
| listDisplayPatternId | 一覧表示パターンID | string | listPageType を指定した場合のみセットされます |
| note | 備考 | string | |
| parentFlowGroups | 親フローグループ | string | リストの先頭（要素数 = 0）にトップ階層の親フローグループが格納され、要素数が増えるごとに順次下位の親フローグループが格納されます。 |
| - flowGroupId | フローグループID | string | |
| - flowGroupName | フローグループ名 | string |
6.1.9.10.13.5. エラーコード¶
| エラーコード | エラーメッセージ | 備考 |
|---|---|---|
| 5062 | 指定された一覧画面種別が不正です。 | listPageType が 「 CodeList 」 のコード値と一致しない場合 |
| 6150 | フローグループ情報の取得に失敗しました。 | フローグループ情報の取得処理に失敗した場合 |