/executiongroups/{egName}/messageflows/{flowName}
Mount Point: /apiv1/executiongroups/{egName}/messageflows/{flowName}
The following operations are supported on this resource:
GET
Get a named flow running inside an execution group.
Parameters
name | description | type | default |
---|---|---|---|
egName | The name of the execution group to look for. | path | |
flowName | flow name to look for | path | |
depth | depth to show children | query | 1 |
Response Body
element: | messageFlow |
message flow response object
PUT
Perform an action on a flow running inside an execution group. The stop can be forced by specifying stopWithRestartExecutionGroup which causes the execution group to be restarted before the stop is executed.
Parameters
name | description | type | default |
---|---|---|---|
egName | execution group to look in | path | |
flowName | flow name to look for | path | |
action | Action to perform on flow: "stop", "stopWithRestartExecutionGroup", "start", "disableTestRecordMode" | query |
Response Body
element: | (custom) |
"HTTP success no content" (204) or exception
DELETE
Delete a flow running inside an execution group (that was deployed in an integration project (not service/app/lib)). The web UI will only show a "Delete" menu item in the context menu of a deployed flow if-and-only-if it was deployed in an integration project (independent project); not if it was deployed in an service/application/library. Look in /webui/apps/ROOT/webui/widgets/common/_TreeNode.js's postCreate() method in the 'case "messageFlow":' section to view the code that filter's out the "Delete" menu item.
Parameters
name | description | type | default |
---|---|---|---|
egName | execution group to look in | path | |
flowName | flow name to look for and delete | path |
Response Body
element: | (custom) |
"HTTP success no content" (204) or exception
PUT
Modify properties of a flow. Currently modifiable properties are:
- archiveStatistics
- snapshotStatistics
Parameters
name | description | type | default |
---|---|---|---|
egName | execution group to look in | path | |
flowName | flow to change properties for | path |
Request Body
element: | messageFlow |
New flow properties to set
Response Body
element: | (custom) |
http 204 (ok no content) if success. Otherwise an exception is thrown.