/executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}
Mount Point: /apiv1/executiongroups/{egName}/restapis/{restApiName}/messageflows/{flowName}
The following operations are supported on this resource:
GET
Get the named message flow in this deployed object group (integration server, application, static or shared library, integration service, or REST API).
Parameters
| name | description | type | default |
|---|---|---|---|
| flowName | flow name to look for | path | |
| depth | depth to show children | query | 1 |
| egName | (no documentation provided) | path | |
| restApiName | (no documentation provided) | path |
Response Body
| element: | messageFlow |
message flow response object
PUT
Perform an action on the named message flow in this deployed object group (integration server, application, static or shared library, integration service, or REST API). The stop can be forced by specifying stopWithRestartExecutionGroup which causes the integration server to be restarted before the stop is executed.
Parameters
| name | description | type | default |
|---|---|---|---|
| flowName | flow name to look for | path | |
| action | Action to perform on flow: "stop", "stopWithRestartExecutionGroup", "start" | query | |
| egName | (no documentation provided) | path | |
| restApiName | (no documentation provided) | path |
Response Body
| element: | (custom) |
"HTTP success no content" (204) or exception
PUT
Modify properties of the named message flow in this deployed object group (integration server, application, static or shared library, integration service, or REST API). Currently modifiable properties are:
- archiveStatistics
- snapshotStatistics
Parameters
| name | description | type | default |
|---|---|---|---|
| flowName | flow to change properties for | path | |
| egName | (no documentation provided) | path | |
| restApiName | (no documentation provided) | 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.
DELETE
Delete the named message flow in this deployed object group (integration server, application, static or shared library, integration service, or REST API). This is only permitted if the deployed object group is the integration server.
Parameters
| name | description | type | default |
|---|---|---|---|
| flowName | flow name to look for and delete | path | |
| egName | (no documentation provided) | path | |
| restApiName | (no documentation provided) | path |
Response Body
| element: | (custom) |
"HTTP success no content" (204) or exception