Waiting for engine...
Skip to main content

Account Cloud Attachment Quota object

Use the Account Cloud Attachment Quota object to programmatically get, create, update, and delete Cloud attachment quotas.

As a Cloud owner, you can designate the number of Atom attachments you can create in a Cloud for an account, edit a Cloud quota's value to raise or lower the limit, or delete the quota. In addition, you can also retrieve a Cloud's existing attachment quota for a given account. The actions supported in the Account Cloud Attachment Quota object represent those you can perform from the service's Cloud Properties tab (Manage > Cloud Management page) to create, edit, and delete Cloud attachment quotas for a given account.

Structure​

<AccountCloudAttachmentQuota>
  <id/>
  <accountId/>
  <cloudId/>
  <maxAtomAttachment/>
</AccountCloudAttachmentQuota>
FieldTypeDescription
idstringA unique ID generated for a newly created or recently updated Cloud quota (using the Account Cloud Attachment quota object). You can use this ID to get a Cloud quota for an account's specific Cloud ID.
accountIdstringThe ID of the account authorizing the call.
cloudIdstringThe ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
maxAtomAttachmentintThe number of Atom attachments that you want to set on the Cloud quota.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedNot SupportedSupportedSupportedNot SupportedSupported

Using the GET operation​

  • Use the GET operation to retrieve the Cloud quota value currently existing for a Cloud ID on a specific account.

  • The GET operation requires an additional ID (id), and differs from the cloudId and accountId. The CREATE response generates and returns this new ID in the CREATE response when you create a new quota or in the CREATE and UPDATE responses when you update a quota's value. You use the id to retrieve an existing Cloud quota value for a given account.

    note

    To generate the id without using the CREATE operation, compute the base64 of accountId:cloudId.

Using the CREATE operation​

  • Use the CREATE operation to create a new Cloud quota and determine the maximum number of Atom attachments that you can create on the account.

  • You can use the CREATE or UPDATE operations interchangeably to edit a Cloud quota value. Both operations can act as an update after creating the quota.

  • CREATE and UPDATE use the same REST endpoint, as seen in the next section of sample code REST calls. When calling the endpoint for an account that has a quota set, the endpoint acts as an update and modifies the existing value, as explained in the previous item. When calling the endpoint for an account that does not already have a quota set, the endpoint creates a new quota.

  • You cannot set the Cloud quota less than the number of attachments that currently exist on the account, unless you are setting the value to -1 for unlimited. Attempting to do so returns an error.

  • The CREATE operation returns an id value that you can use in a GET operation to retrieve the existing quota for a specific account's Cloud ID.

Using the UPDATE operation​

  • You can use the UPDATE operation to edit the number of Atom attachments that you can create on the given account. Specify the IDs of both the account and the Runtime cloud that you want to update.

  • You can use the CREATE or UPDATE operations interchangeably to edit a Cloud quota value. Both operations can act as an update when creating the quota.

  • CREATE and UPDATE use the same REST endpoint, as seen in the next section of sample code REST calls. When calling the endpoint for an account that has a quota set, the endpoint acts as an update and modifies the existing value, as explained in the previous item. When calling the endpoint for an account that does not already have a quota set, the endpoint creates a new quota.

  • You cannot set the Cloud quota less than the number of attachments that currently exist on the account, unless you are setting the value to -1 for unlimited. Attempting to do so returns an error.

Using the DELETE operation​

  • Use the DELETE operation to delete a Cloud quota for a given account.

SOAP implementation​

POST Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="http://api.platform.boomi.com/">
    <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>user@boomi.com</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password123</wsse:Password>
        </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <par:get>
            <par:objectType>AccountCloudAttachmentQuota</par:objectType>        <par:objectId>b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA</par:objectId>
        </par:get>
    </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:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:result xsi:type="bns:AccountCloudAttachmentQuota" id="b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA" accountId="account-123456" cloudId="23456789-abcd-ef01-2345-6789abcdef01" maxAtomAttachment="4"/>
        </bns:getResponse>
    </S:Body>
</S:Envelope>
On this Page