/executiongroups/{egName}
Mount Point: /apiv1/executiongroups/{egName}
The following operations are supported on this resource:
PUT
Performs an action on the execution group. If the action is a stop/start option ("stop", "stopWithRestartExecutionGroup", "start") then the execution group is stopped/started as directed. The stop can be forced by specifying stopWithRestartExecutionGroup which causes the execution group to be restarted before the stop is executed.
If the action is a "setStatistics", then the "setStatistics" or "setResourceStatistics" parameters dictate changes to statistics for all child messageflows or resource managers respectively. Specifying a value of "on" for the "setStatistics" parameter turns on statistics with json output format, and sets the node and thread level to basic. Specifying a value of "off" for the "setStatistics" parameter turns off all statistics and unsets all output formats. Specifying a value of "on" for the "setResourceStatistics" parameter turns on statistics for all resource types on the execution group. Specifying a value of "off" for the "setResourceStatistics" parameter turns off statistics for all resource types on the execution group.
If the action is a "setBusinessRecorder" then the businessRecorderUri indicates what value will be assigned. The execution group properties will have a businessTransactionPolicyUri.
If the action is "enableTestRecordMode" then test data is recorded and made available whenever a message passes through a message flow. If the action is "disableTestRecordMode" then no test data is recorded when a message passes through a message flow. (To retrieve or clear recorded data see /apiv1/test/recordedtestdata.)
If the action is "enableInjectionMode" then the server will accept injected messages. If the action is "disableInjectionMode" then the server will refuse injected messages. (To inject previously recorded data see /apiv1/test?action=inject.)
Parameters
| name | description | type | default |
|---|---|---|---|
| egName | execution group name | path | |
| action | Action to perform on flow, actions include: "stop", "stopWithRestartExecutionGroup", "start", "setStatistics", "setResourceStatistics", "setBusinessRecorder", "enableInjectionMode", "disableInjectionMode", "deleteAll", "stopAllMessageFlows", "stopAllApplicationTypes", "startAllMessageFlows", "startAllApplicationTypes" | query | |
| setStatistics | setStatistics to "on" or "off". Only used with "action=setStatistics" | query | |
| setResourceStatistics | setResourceStatistics to "on" or "off". Only used with "action=setStatistics" | query | |
| businessRecorderUri | businessRecorderUri Only used with "action=setBusinessRecorder" | query | |
| newName | (no documentation provided) | query |
Response Body
| element: | (custom) |
"HTTP success no content" (204) or exception
GET
Get the named execution group.
Parameters
| name | description | type | default |
|---|---|---|---|
| egName | The name of the execution group to view | path | |
| depth | Depth to expand children to | query | 1 |
Response Body
| element: | executionGroup |
(no documentation provided)
DELETE
Delete execution group
Parameters
| name | description | type | default |
|---|---|---|---|
| egName | Name of execution group to be deleted | path |
Response Body
| element: | (custom) |
Response