SOAP API Reference › Web Services Methods › deleteArchivedInstances

deleteArchivedInstances

Use this method to delete the archived instances of a CA Process Automation Orchestrator.

Example

<tns:deleteArchivedInstances xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type-->
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:dateRange>
<tns:fromDate>2012-02-02T02:00:00.320+05:30</tns:fromDate>
<tns:toDate>2012-02-02T03:00:00.320+05:30</tns:toDate>
</tns:dateRange>
</tns:deleteArchivedInstances>

SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header/><SOAP-ENV:Body>
<tns:deleteArchivedInstances xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:dateRange>
<tns:fromDate>2012-02-02T02:00:00.320+05:30</tns:fromDate>
<tns:toDate>2012-02-02T03:00:00.320+05:30</tns:toDate>
</tns:dateRange>
</tns:deleteArchivedInstances>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You can specify the <dateRange> in the <fromDate> and <toDate> tags to delete archived instances. Use the Standard XSD format 2002-05-30T09:00:00.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<deleteArchivedInstancesResponse xmlns="http://www.ca.com/itpam">
<successMessage>4 archived instances were deleted successfully.</successMessage>
</deleteArchivedInstancesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<successMessage> shows the successful deletion of instances and the number of instances deleted.

When there are no instances in the given period, the response will be:

<deleteArchivedInstancesResponse xmlns="http://www.ca.com/itpam">
<successMessage>No archived instance is available for the specified date range.</successMessage>
</deleteArchivedInstancesResponse>