Delete Plan Actions API

The Delete Plan Actions API supports bulk deletion of plan actions. GET /serverautomation/bulkplanactionoperation/delete-plan-actions returns the XML template, and POST /serverautomation/bulkplanactionoperation/ submits the completed template with plan-action-ids and optional exclusions to perform the deletion. The response reports deleted, invalid, and excluded IDs and any errors.

Table 1. Delete Plan Actions API
Method Summary
GET

Endpoint: /serverautomation/bulkplanactionoperation/delete-plan-actions

Description: Used for retrieving the XML template for bulk deletion of plan actions.

Required Request Content: Only the URL is required.

Response Content: Template for the bulk deletion of plan actions.

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-plan-actions">
        <plan-action-ids> </plan-action-ids>
        <exclusions> </exclusions>
    </bulk-operation>
</sa-rest>

Sample Response Content: N/A.
POST

Endpoint: /serverautomation/bulkplanactionoperation/

Description: Deletes the plan actions whose IDs are provided as input.

Required Request Content: A completed bulk operation delete plan actions 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-plan-actions">
                <plan-action-ids>3993,3945-3950</plan-action-ids>
                <exclusions>3947</exclusions>
        </bulk-operation> 
</sa-rest>

Response Content: The result of the bulk delete of plan actions 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-plan-action-ids>3993,3945,3946,3948,3949</deleted-plan-action-ids>
        <invalid-plan-action-ids />
        <excluded-plan-action-ids>3947</excluded-plan-action-ids>
        <errors>
            <error>
                <planactionid>3950</planactionid>
                <statuscode>404</statuscode>
                <msg>Object Not Found</msg>
            </error>
        </errors>
    </result>
</sa-rest>

Sample Response Content: N/A.
PUT

Not supported for this resource.
DELETE

Not supported for this resource.