Execute Plan API

The Execute Plan API provides endpoints to retrieve plan execution templates and to execute or submit automation plans in master and non-master action sites.

Use GET to obtain the plan execution template XML and POST the same template to run the plan; responses conform to SA-REST.xsd and return the new plan or plan action ID. Only the execution-order timeout and threshold values are editable, and PUT and DELETE are not supported.

Table 1. Execute Plan API
Method	Summary
GET	Endpoint: /serverautomation/plan/{site type}/{object id} Description: Retrieves the automation plan execution template for the master action site specified by the URL. Required Request Content: Only the URL is required. Response Content: Plan execution template XML for the plan specified by the URL. Response Schema: SA-REST.xsd Sample Response Content: Refer to Sample_Plan_Schema.xml.
GET	Endpoint: /serverautomation/plan/{site type}/{site name}/{object id} Description: Retrieves the automation plan execution template for the non-master action site specified by the URL. Note: Non-master sites can be external, custom, or operator sites. Required Request Content: Only the URL is required. Response Content: Plan execution template XML for the plan specified by the URL. Response Schema: SA-REST.xsd Sample Response Content: Refer to Sample_Plan_Schema.xml.
POST	Endpoint: /serverautomation/plan/{site type}/{object id} Description: Executes or submits the automation plan in the master action site specified by the URL. Required Request Content: Complete object XML/Schema in the request body (the same object that is received as the GET method’s response). Response Content: Newly created automation plan ID. Response Schema: SA-REST.xsd Sample Response Content: NA
POST	Endpoint: /serverautomation/plan/{site type}/{site name}/{object id} Description: Executes or submits the automation plan in the non-master action site specified by the URL. Note: Non-master sites can be external, custom, or operator sites. Required Request Content: Complete object XML/Schema in the request body (the same object that is received as the GET method’s response). Response Content: Newly created automation plan action ID. Response Schema: SA-REST.xsd Sample Response Content: NA
PUT	Not supported for this resource.
DELETE	Not supported for this resource.

Note:

For the most recent XML description of all the methods, see SA-REST.xsd
In the API, Object ID refers to Plan ID.
Per the execute plan template, under execution-order, only timeout and threshold values can be changed.

Refer to Scheduling Settings to learn more.