Create Plan API

The Create Plan API provides endpoints to retrieve the plan template and to create, modify, or delete Server Automation plans in master and non-master action sites.

GET returns a plan schema defined by SA-REST.xsd; POST/PUT require the complete plan XML and return the plan name and ID, and DELETE removes a plan by Object ID (Plan ID).
Table 1. Create Plan API
Method Summary
GET

Endpoint: /serverautomation/besplan/{site type}/{object id}

Description: Retrieves the automation plan creation template for the master action site.

Required Request Content: URL is all that is required.

Response Content: A plan schema that can be used for creating or modifying plan APIs.

Response Schema: SA-REST.xsd

Sample Response Content: Refer to Sample_Plan_Schema.xml.
GET

Endpoint: /serverautomation/besplan/{site type}/{site name}/{object id}

Description: Retrieves the automation plan creation template for the specified non-master action site.
Note: Non-master sites can be external, custom, or operator sites.

Required Request Content: URL is all that is required.

Response Content: A plan schema that can be used for creating or modifying plan APIs.

Response Schema: SA-REST.xsd

Sample Response Content: Refer to Sample_Plan_Schema.xml.
POST

Endpoint: /serverautomation/besplan/{site type}

Description: Creates 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 returned in the GET method’s response).

Response Content: The newly created automation plan name and ID.

Response Schema: SA-REST.xsd

Sample Response Content: In the sample response below, refer to the new tags created specifically for custom targets. For example: 
<failure-targets>Custom</failure-targets> 
    <target-set> 
        <group name="Group1" id="402"></group> 
        <computer name="BLMYCLDTW11681" id="13435686"></computer> 
</target-set>
Note: Server Automation is capturing the failure custom target details as a part of the create/modify plan schema itself. Define your own user-defined targets.
POST

Endpoint: /serverautomation/besplan/{site type}/{site name}

Description: Creates 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 returned in the GET method’s response).

Response Content: The newly created automation plan name and ID.

Response Schema: SA-REST.xsd

Sample Response Content: In the sample response below, refer to the new tags created specifically for custom targets. For example: 
<failure-targets>Custom</failure-targets> 
    <target-set> 
        <group name="Group1" id="402"></group> 
        <computer name="BLMYCLDTW11681" id="13435686"></computer> 
</target-set>
Note: Server Automation is capturing the failure custom target details as a part of the create/modify plan schema itself. Define your own user-defined targets.
PUT

Endpoint: /serverautomation/besplan/{site type}/{object id}

Description: Modifies or updates 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 returned in the GET method’s response).

Response Content: The modified/updated plan name and plan ID.

Response Schema: SA-REST.xsd

Sample Response Content: In the sample response below, refer to the new tags created specifically for custom targets. For example: 
<failure-targets>Custom</failure-targets> 
    <target-set> 
        <group name="Group1" id="402"></group> 
        <computer name="BLMYCLDTW11681" id="13435686"></computer> 
</target-set>
Note: Server Automation captures the failure custom target details as part of the create/modify plan schema itself.
PUT

Endpoint: /serverautomation/besplan/{site type}/{site name}/{object id}

Description: Modifies or updates the automation plan in the non-master action site specified by the URL.

NOTE: Non-master sites can be custom or operator sites.

Required Request Content: Complete object XML/Schema in the request body (the same object that is returned in the GET method’s response).

Response Content: The modified/updated plan name and plan ID.

Response Schema: SA-REST.xsd

Sample Response Content: In the sample response below, refer to the new tags created specifically for custom targets. For example: 
<failure-targets>Custom</failure-targets> 
    <target-set> 
        <group name="Group1" id="402"></group> 
        <computer name="BLMYCLDTW11681" id="13435686"></computer> 
</target-set>
Note: Server Automation captures the failure custom target details as part of the create/modify plan schema itself.
DELETE

Endpoint: /serverautomation/besplan/{site type}/{object id}

Description: Deletes the automation plan in the master action site specified by the URL.

Required Request Content: URL is all that is required.

Response Content: The deleted plan ID.

Response Schema: SA-REST.xsd

Sample Response Content: N/A.
DELETE

Endpoint: /serverautomation/besplan/{site type}/{site name}/{object id}

Description: Deletes the automation plan in the non-master action site specified by the URL.

NOTE: Non-master sites can be custom or operator sites.

Required Request Content: URL is all that is required.

Response Content: The deleted plan ID.

Response Schema: SA-REST.xsd

Sample Response Content: N/A.
Note:
  • For the most recent XML description of all the methods, see SA-REST.xsd
  • In the API, Object ID refers to Plan ID.