/executiongroups/{egName}/services/{svcName}/messageflows/{flowName}
Mount Point: /apiv1/executiongroups/{egName}/services/{svcName}/messageflows/{flowName}
The following operations are supported on this resource:
GET
Get a named message flow from a service.
Parameters
| name | description | type | default |
|---|---|---|---|
| egName | The name of the execution group to look for. | path | |
| svcName | The name of the service 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 a service 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 | |
| svcName | service name to look for the flow in | path | |
| flowName | flow name to stop or start | path | |
| action | Action to perform on flow: "stop", "stopWithRestartExecutionGroup", "start", "disableTestRecordMode" | 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 | |
| svcName | service name to look for the 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.