Remove Targets API

Use the Remove Targets API to bulk remove specified computers and groups from the normal steps of automation plans. Send a GET to /serverautomation/bulkplanoperation/remove-targets to retrieve the XML template, then POST the completed template to /serverautomation/bulkplanoperation/master to remove targets from the listed plan IDs. Targets in failure steps are not modified.

Bulk operations on automation plans (such as deleting plans and removing targets from normal steps) are specified by the URL using the bulk operation XML document.
Note: When used to remove targets, this API removes the targets only from the normal steps, not from the failure steps.
Table 1. Remove Targets API
Method Summary
GET

Endpoint: /serverautomation/bulkplanoperation/remove-targets

Description: Retrieves the XML template for the bulk removal of plan targets for both the master and non-master action sites.

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

Response Content: Template for bulk removal of plan targets.

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="remove-targets">
        <plan-ids> </plan-ids>
        <exclusions> </exclusions>
        <targets>
            <target-computer name="" id=”"/> 
            <target-group name="" id=""/>
        </targets>
    </bulk-operation>
</sa-rest>

Sample Response Content: N/A.
POST

Endpoint: /serverautomation/bulkplanoperation/master

Description: Removes the given target computers and groups from the plans whose IDs are provided in the XML document.

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="remove-targets">
                <plan-ids>3993,3945-3950</plan-ids>
                <exclusions> </exclusions>
                        <targets>
                                <target-computer name="Win_11_Enterprise" id="33895"/>
                                <target-group name="Windows_GP1_XP" "id=33859"/>
                        </targets>
        </bulk-operation> 
</sa-rest>

Response Content: The result of bulk plan target removal 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>
                <modified-plans>32550, 32555, 32556, 32557, 32558, 32559</modified-plans>
                <invalid-plan-ids/>
                <excluded-plan-ids/>
                <invalid-targets>
                        <invalid-target-computers> </invalid-target-computers>
                        <invalid-target-groups>Reporting</invalid-target-groups>
                </invalid-targets>
        </result>
</sa-rest>

Sample Response Content: N/A.
PUT

Not supported for this resource.
DELETE

Not supported for this resource.