Boomi Platform API Reference (1.0.0) - AtomPurge

Toggle Pane

• Purge Atom Cloud attachment
  • postModifies or updates an AtomPurge object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Purge Atom Cloud attachment

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 Atom 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 Atom 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.

Modifies or updates an AtomPurge object

You can use the Purge Runtime 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.

Authorizations:

basicAuth

path Parameters

id required

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 Runtime Information panel for a selected Runtime.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

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 Runtime Information panel for a selected Runtime.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 Runtime Information panel for a selected Runtime.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AtomPurge/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "3456789a-bcde-f012-3456-789abcdef012",
• "purgeHistoryDays": 90,
• "atomId": "3456789a-bcde-f012-3456-789abcdef012"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AtomPurge",
• "atomId": "3456789a-bcde-f012-3456-789abcdef012"

}