Using the REST API to restart a task
search cancel

Using the REST API to restart a task

book

Article ID: 429221

calendar_today

Updated On:

Products

CA Automic Workload Automation - Automation Engine CA Automic One Automation

Issue/Introduction

Is there an endpoint to restart a task via rest api?  Looking for something similar to right-clicking a task in the AWI and choosing Modify -> Restart or using RESTART_UC_OBJECT.  When searching through the REST API documentation for "restart", only RestartOptions comes up under schemas.

Environment

Version: 24.X

Resolution

There is an endpoint that can do this which is the POST method for /{client_id}/executions/{run_id}/status.  Under the example dropdown, there are options for restarts:

The EXAMPLE RESTART SIMPLE has a simple body like:

{
  "action": "RESTART"
}

and will have the same behavior as RESTART_UC_OBJECT (Object Name, Reference RUN#) that is referenced in the documentation for RESTART_UC_OBJECT.