Purge Atom Cloud attachment operation

You can use the Purge Atom Cloud attachment operation to programmatically start the purge process for test and browse components, logs, processed documents, and temporary data for a Runtime cloud attachment.

You can use the Purge Runtime cloud attachment operation for any Runtime cloud attachment. You must be a Cloud owner and have the Runtime Management privilege to use the this operation.

The Purge Runtime cloud attachment operation works the same as a purge schedule, starting the process according to any of the following properties specified in the Properties and the Account Properties(Advanced tab) panels of Runtime Management:

• Purge History After X Days
• Purge Schedule for Components
• Purge Schedule for Logs
• Purge Schedule for Processed Documents
• Purge Schedule for Temporary Data

This operation honors existing purge schedule settings defined in the Integration user interface. For example, suppose that the Purge History After X Days property is set to seven days. If you run the Purge Runtime cloud attachment operation, it only deletes files that are older than seven days. If the operation does not find any files that match this criterion, it does not purge any files. For more information about purge schedules, see related links.

Structure

<AtomPurge atomId=""/>

Field	Type	Description
atomId	string	The unique ID assigned by the system to the Runtime cloud attachment. The Runtime ID is found in the user interface by navigating to Manage > Runtime Management and viewing the Atom Information panel for a selected Runtime.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported	Not Supported	Not Supported	Supported	Not Supported	Not Supported

Using the EXECUTE operation

• You must have the Runtime Management privilege to perform the EXECUTE operation. If you have the Runtime Management Read Accessprivilege, you cannot use this operation to start the purge process.

• The EXECUTE operation initiates the purge process based on any purge properties you set in the Account Properties and Properties panels.

SOAP implementation

EXECUTE operation

Sample SOAP request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <api:update>
      	<object xsi:type="api:AtomPurge" atomId="3456789a-bcde-f012-3456-789abcdef012" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
		</object>
         <api:accountId>boomi-internal</api:accountId>
      </api:update>
   </soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:AtomPurge" atomId="3456789a-bcde-f012-3456-789abcdef012"/>
        </bns:updateResponse>
    </S:Body>
</S:Envelope>