6.1.9.9.1. フローグループ/フロー構造情報取得¶
フローグループ/フロー構造情報を取得します。
6.1.9.9.1.1. HTTP リクエスト¶
GET /api/workflow/flow-group-definitions/flow-tree
6.1.9.9.1.2. レスポンスデータ¶
6.1.9.9.1.2.1. JSON¶
{
"flowTree": [
{
"childNodes": [
{}
],
"identify": "string",
"label": "string",
"parentFlowGroupId": "string",
"type": "string"
}
],
"noBelongFlows": [
{
"childNodes": [
{}
],
"identify": "string",
"label": "string",
"parentFlowGroupId": "string",
"type": "string"
}
]
}
6.1.9.9.1.2.2. 詳細¶
プロパティ名 | 論理名 | 型 | 説明 |
---|---|---|---|
flowTree | フローグループに属したフローのツリー構造 | array<object> | |
- childNodes | 子情報 | array<object> | フローグループまたはフローの情報です。
※子情報が存在する場合にセットされます。親情報と同様のプロパティを持ちます。
|
- identify | フローツリーノード識別子 | string | フローグループの場合は、「フローグループID」を表すコードです。
例: flow_group_javaee
フローの場合は、「%フローグループID% + "/" + %フローID%」を表すコードです。
例: flow_group_javaee/flow_javaee_01
|
- label | 表示名 | string | フローグループ名またはフロー名が入ります。 |
- parentFlowGroupId | 親フローグループのID | string | |
- type | フローグループかフローかを識別する情報 | string | フローグループの場合は「flow_group」です。
フローの場合は「flow」です。
|
noBelongFlows | フローグループに属さないフローのツリー構造 | array<object> | |
- childNodes | 子情報 | array<object> | 常に空です。 |
- identify | フローツリーノード識別子 | string | 「"/" + %フローID%」を表すコードです。
例: /flow_javaee_01
|
- label | 表示名 | string | フロー名が入ります。 |
- parentFlowGroupId | 親フローグループのID | string | 常に空です。 |
- type | フローグループかフローかを識別する情報 | string | 常に「flow」です。 |
6.1.9.9.1.3. エラーコード¶
エラーコード | エラーメッセージ | 備考 |
---|---|---|
6316 | フローグループ/フロー構造情報の取得に失敗しました。管理者に連絡してください。 | 管理者に連絡してください。 |
6317 | フローグループ階層情報の取得に失敗しました。管理者に連絡してください。 | 管理者に連絡してください。 |
6318 | フローグループに属するフロー情報の取得に失敗しました。管理者に連絡してください。 | 管理者に連絡してください。 |
6319 | フローグループ内包情報(フローID含む)の配列の取得に失敗しました。管理者に連絡してください。 | 管理者に連絡してください。 |