/executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}

Mount Point: /apiv1/executiongroups/{egName}/libraries/{libName}/messageflows/{flowName}

The following operations are supported on this resource:

GET

Get a named message flows from a named library.

Parameters

name description type default
egName The name of the execution group to look for. path
libName The name of the library to look for. path
flowName The name of the flow to get. path
depth Depth to expand children to. query 1

Response Body

element: messageFlow

(no documentation provided)

PUT

Perform and action on a flow running inside a library, 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
libName library name to look for 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:

Parameters

name description type default
egName execution group to look in path
flowName flow to change properties for path
libName library name to look for flow in 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.