Boomi Platform API Reference (1.0.0) - AccountCloudAttachmentQuota

Toggle Pane

• AccountCloudAttachmentQuota
  • postCreates an AccountCloudAttachmentQuota object
  • getRetrieves an instance of an AccountCloudAttachmentQuota object
  • postModifies or updates an AccountCloudAttachmentQuota object
  • delDeletes an AccountCloudAttachmentQuota object
  • postRetrieves multiple AccountCloudAttachmentQuota objects by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountCloudAttachmentQuota

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

Creates an AccountCloudAttachmentQuota object

• Use the CREATE operation to create a new Cloud quota and determine the maximum number of Runtime 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.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountId	string The ID of the account authorizing the call.
cloudId	string The ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
id	string A 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.
maxAtomAttachment	integer <int32> The number of Runtime attachments that you want to set on the Cloud quota.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountId	string The ID of the account authorizing the call.
cloudId	string The ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
id	string A 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.
maxAtomAttachment	integer <int32> The number of Runtime attachments that you want to set on the Cloud quota.

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}/AccountCloudAttachmentQuota

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "accountId": "account-123456",
• "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
• "maxAtomAttachment": "5"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
• "accountId": "account-123456",
• "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
• "maxAtomAttachment": "5"

}

Retrieves an instance of an AccountCloudAttachmentQuota object

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

Authorizations:

basicAuth

path Parameters

id required

string A 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.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountId	string The ID of the account authorizing the call.
cloudId	string The ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
id	string A 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.
maxAtomAttachment	integer <int32> The number of Runtime attachments that you want to set on the Cloud quota.

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}/AccountCloudAttachmentQuota/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountCloudAttachmentQuota",
• "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St",
• "accountId": "account-123456",
• "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
• "maxAtomAttachment": 5

}

Modifies or updates an AccountCloudAttachmentQuota object

Edit the number of Runtime 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 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.

Authorizations:

basicAuth

path Parameters

id required

string A 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.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountId	string The ID of the account authorizing the call.
cloudId	string The ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
id	string A 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.
maxAtomAttachment	integer <int32> The number of Runtime attachments that you want to set on the Cloud quota.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountId	string The ID of the account authorizing the call.
cloudId	string The ID of the Runtime cloud that you want to get, add, edit, or delete a Cloud quota.
id	string A 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.
maxAtomAttachment	integer <int32> The number of Runtime attachments that you want to set on the Cloud quota.

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}/AccountCloudAttachmentQuota/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "accountId": "account-123456",
• "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
• "maxAtomAttachment": "8"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
• "accountId": "account-123456",
• "cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
• "maxAtomAttachment": "8"

}

Deletes an AccountCloudAttachmentQuota object

Deletes a Cloud quota for a given account.

Authorizations:

basicAuth

path Parameters

id required

string A 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.

Responses

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}/AccountCloudAttachmentQuota/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple AccountCloudAttachmentQuota objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (AccountCloudAttachmentQuota) index integer <int32> id string statusCode integer <int32> errorMessage string

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}/AccountCloudAttachmentQuota/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "accountId": "string",
      • "cloudId": "string",
      • "id": "string",
      • "maxAtomAttachment": 0

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}