CloudAttachmentProperties object

The CloudAttachmentProperties API lets you manage and configure cloud attachment properties for runtimes, including runtime configuration settings, purge schedules, and account-level properties.

Structure

Initial GET response

<bns:AsyncOperationTokenResult responseStatusCode="202">
    <bns:asyncToken token=""/>
</bns:AsyncOperationTokenResult>

Subsequent GET response

<bns:AsyncOperationResult responseStatusCode="200">
    <bns:result xsi:type="bns:CloudAttachmentProperties" archiveProcessedDocuments="" containerName="" containerPurgeDays="" containerPurgeImmediately="" defaultTimeZoneForAccountSchedules="" lowLatencyWarningThreshold="" purgeScheduleForComponents="" purgeScheduleForLogs="" purgeScheduleForProcessedDocuments="" purgeScheduleForTemporaryData="" runtimeId=""/>
</bns:AsyncOperationResult>

Update request

<bns:CloudAttachmentProperties runtimeId="" partialUpdate="" defaultTimeZoneForAccountSchedules="" containerName="" containerPurgeImmediately="" archiveProcessedDocuments="" purgeScheduleForComponents="" purgeScheduleForLogs="" containerPurgeDays="" purgeScheduleForProcessedDocuments="" purgeScheduleForTemporaryData="" lowLatencyWarningThreshold=""/>

Update response

<bns:CloudAttachmentProperties runtimeId="" defaultTimeZoneForAccountSchedules="" containerName="" containerPurgeImmediately="" archiveProcessedDocuments="" purgeScheduleForComponents="" purgeScheduleForLogs="" containerPurgeDays="" purgeScheduleForProcessedDocuments="" purgeScheduleForTemporaryData="" lowLatencyWarningThreshold=""/>

Required privileges:

You need these privileges in the target environment:

• Write access

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

• Read access

  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

  • OR ATOM_MANAGEMENT_READ_ONLY

Field	Type	Description
archiveProcessedDocuments	boolean	If set to true, processed document archiving is enabled for the selected runtime attached to a private runtime cloud, provided the runtime cloud owner has enabled archiving on the runtime cloud and allowed archiving for the selected runtime.
containerName	string	Required. Name of the selected runtime that is attached to a runtime cloud. The containerName field is required when partialUpdate is set to false.
containerPurgeDays	integer	Specifies the number of days after process execution when logs, processed documents, components, and temporary data are purged. Refer to the topic Purging of runtime logs and data for more details.
containerPurgeImmediately	boolean	If set to true, processed documents, component, and temporary data will be purged immediately after a process execution ends.
defaultTimeZoneForAccountSchedules	string	Specifies the time zone for process schedules run on this attachment. By default, schedules use the time zone of the cloud hosting the attachment is installed. Setting this property, however, overrides the time zones of process schedules run on the specified attachment.
lowLatencyWarningThreshold	integer	Defines the time, in milliseconds, after which a successful low-latency process is flagged with a warning. If you set it to 0 or less, the warning is disabled. If this value exists in the account.properties file, then it is used. If the value does not exist in the account.properties file or if the account.properties file does not exist, then this value is read from the container.properties file.
partialUpdate	boolean	Supplied only in an UPDATE operation. Determines how existing cloud attachment properties get updated. By default, it is set to false. If set to true, only the property values specified in the request get updated. All other existing properties within the runtime will remain unchanged. If set to false, property values specified in the request get updated. However, other property values not included in the request are reset to their default values.
purgeScheduleForComponents	integer	The number of days to wait before purging test execution and browse component data held on your runtime. The default value is 0, which means the property is disabled until a user configures it with a positive integer to enable the purge. Note: Shared HTTP Server SSL Certificates and Certificate Authorization components are not purged when this property is enabled. Refer to the topic Purging of runtime logs and data for more details.
purgeScheduleForLogs	integer	Refer to the topic Purging of runtime logs and data for details.
purgeScheduleForProcessedDocuments	integer	Refer to the topic Purging of runtime logs and data for details.
purgeScheduleForTemporaryData	integer	Refer to the topic Purging of runtime logs and data for details.
runtimeId	string	Read-only and required. System-generated unique identifier of a runtime. To view the runtime ID in the UI, go to Manage > Runtime Management.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

Using the GET operation

Retrieves the details of cloud attachment properties of a specific runtime. Retrieving cloud attachment properties is an asynchronous process:

1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform. https://api.boomi.com/api/soap/v1/<accountId>/async/CloudAttachmentProperties/<runtimeId>
   The accountId is the ID of the authenticating account for the request, and runtimeId is the ID of the runtime.
2. The platform returns a token.
3. Send one or more GET requests that include the token. https://api.boomi.com/api/soap/v1/<accountId>/async/CloudAttachmentProperties/response/<token>
4. The platform returns a list of the cloud attachment properties associated with the specific runtime.

note

The runtime that you are calling must be online.

Initial GET response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
    <soapenv:Body>
        <api:asyncResult>
            <api:token>CloudAttachmentProperties-3aa47348-1f87-4014-95ca-4db5d752e82a</api:token>
        </api:asyncResult>
    </soapenv:Body>
</soapenv:Envelope>

Subsequent GET response

<?xml version='1.0' encoding='UTF-8'?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncResultResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results responseStatusCode="200">
                <bns:result xsi:type="bns:CloudAttachmentProperties" runtimeId="7ee105f7-6a9e-4b62-b383-3f6f3121ffc0" defaultTimeZoneForAccountSchedules="IST" containerName="Cloud_attachment_1" containerPurgeImmediately="false" containerPurgeDays="48"/>
            </bns:results>
        </bns:asyncResultResponse>
    </S:Body>
</S:Envelope>

Using the UPDATE operation

Adds, removes, or updates cloud attachment properties for a specific runtime. The update operation includes the optional flag, partialUpdate. By default, it is set to false:

• If set to true, only the property values specified in the request get updated. All other existing properties within the runtime will remain unchanged.
• If set to false, property values specified in the request get updated. However, other property values not included in the request are reset to their default values.

note

To reset a property to its default value in the account.properties file, set partialUpdate to false without including the property values in the request.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
 <soapenv:Body>
      <api:update>
          <object xsi:type="api:CloudAttachmentProperties"
              partialUpdate="true"
              runtimeId="7ee105f7-6a9e-4b62-b383-3f6f3121ffc0" 
              defaultTimeZoneForAccountSchedules="IST" 
              containerName="Cloud_attachment_1" 
              containerPurgeImmediately="false" 
              containerPurgeDays="48"  
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> 
      </api:update>
 </soapenv:Body>
</soapenv:Envelope>

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:CloudAttachmentProperties" runtimeId="7ee105f7-6a9e-4b62-b383-3f6f3121ffc0" defaultTimeZoneForAccountSchedules="IST" containerName="Cloud_attachment_1" containerPurgeImmediately="false" containerPurgeDays="48"/>
      </bns:updateResponse>
  </S:Body>
</S:Envelope>