Delete Plans API

Delete Plans API enables bulk deletion of plans for master and non-master action sites. Use GET /serverautomation/bulkplanoperation/delete-plans to retrieve the XML template, then POST the completed template to /serverautomation/bulkplanoperation/master or /serverautomation/bulkplanoperation/custom/{site} to execute the deletion. Responses return deletion results in XML for the master site or an automation plan action ID for non-master sites; PUT and DELETE are not supported.

Table 1. Delete Plans API
Method Summary
GET

Endpoint: /serverautomation/bulkplanoperation/delete-plans

Description: Retrieves the XML template for bulk deletion of plans for both the master and non-master action sites.

Required Request Content: The URL is all that is required.

Response Content: Template for bulk deletion of plans.

Response Schema: 
<?xml version="1.0" encoding="UTF-8"?>
<sa-rest xmlns="http://iemfsa.tivoli.ibm.com/REST" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <bulk-operation name="delete-plans">
        <plan-ids> </plan-ids>
        <exclusions> </exclusions>
    </bulk-operation>
</sa-rest>

Sample Response Content: N/A.
POST

Endpoint: /serverautomation/bulkplanoperation/master

Description: Deletes the plans whose IDs are given as input for the master action site specified by the URL.

Required Request Content: A completed bulk operation delete plans template XML document. For example: 
<?xml version="1.0" encoding="UTF-8"?>
<sa-rest xmlns="http://iemfsa.tivoli.ibm.com/REST" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <bulk-operation name="delete-plans">
                <plan-ids>31234,3726-3731</plan-ids>
                <exclusions>3727-3729</exclusions>
        </bulk-operation> 
</sa-rest>

Response Content: The result of bulk plan deletion in XML format.

Response Schema: 
<?xml version="1.0" encoding="UTF-8"?>
<sa-rest xmlns="http://iemfsa.tivoli.ibm.com/REST" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <result>
        <deleted-plans>3726,3730,3731</deleted-plans>
        <invalid-plan-ids />
        <excluded-plan-ids></excluded-plan-ids>
        <errors>
            <error>
                <planid>31234</planid>
                <statuscode>400</statuscode>
                <msg>Plan does not exist or already deleted</msg>
            </error>
        </errors>
    </result>
</sa-rest>

Sample Response Content: N/A.
POST

Endpoint: /serverautomation/bulkplanoperation/custom/My_site

Description: Deletes the plans whose IDs are given as input for the non-master action site specified by the URL. Also, the site type and site name need to be sent in the request.
Note: Non-master sites can be external/custom/operator sites.

Required Request Content: A complete object XML/Schema in the request body (the same object that we receive as the GET method’s response).

Response Content: A newly created automation plan action ID.

Response Schema: SA-REST.xsd

Sample Response Content: N/A.
PUT

Not supported for this resource.
DELETE

Not supported for this resource.