AE REST API - Working with Executed Objects
You can restart and or cancel executions.
This page includes the following:
Restart Execution
Simple (No Parameters)
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Passing neither input nor any restart related parameters.
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{ "action": "restart" }
HTTP 200 Response:
{ "run_id": 26350635 }
All Possible Parameters
Restart with all possible parameters.
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Passing input parameters (PromptSet values) and restart related parameters.
Example:http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{ "action": "restart", "restart": { "queue": "FAST.QUEUE", "restart_point": "RP2", "keep_start_type": "true", "wait_for_manual_release": "false", "inputs": { "TEXT1#": "restart text", "NUMBER1#": "123456789" } } }
HTTP 200 Response:
{ "run_id": 26350635 }
Cancel Execution
Non-Recursive
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
{ "action": "cancel" }
HTTP 200 Response:
{}
Recursive
Request: POST http://{host}:{port}/ae/api/v1/{client}/executions/{run id}/status
Applies only to executable objects that can have children (JSCH, JOBP, and JOBG).
Example: http://my-jcp-host:8088/ae/api/v1/8001/executions/23021234/status
HTTP 200 Response:
{}
See also: