/executiongroups/{egName}/applications/{appName}/messageflows/{flowName}
Mount Point: /apiv1/executiongroups/{egName}/applications/{appName}/messageflows/{flowName}
The following operations are supported on this resource:
GET
Get the named message flow from an application.
Parameters
name | description | type | default |
---|---|---|---|
egName | The name of the execution group to look for. | path | |
appName | The name of the application to look for. | path | |
flowName | The name of the message flow to look for. | path | |
depth | Depth to expand children to. | query | 1 |
Response Body
element: | messageFlow |
(no documentation provided)
PUT
Perform an action on a flow running inside an application, 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 for application in | path | |
appName | application name to look for the message flow in | path | |
flowName | flow name to stop or start | path | |
action | Action to perform on flow: "stop", "stopWithRestartExecutionGroup", "start" | query |
Response Body
element: | (custom) |
"HTTP success no content" (204) or exception
PUT
Modify properties of a flow. Currently modifiable properties are:
- archiveStates
- snapshotStates
Parameters
name | description | type | default |
---|---|---|---|
egName | execution group to look in | path | |
appName | application name to look for the message flow 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.