Boomi Platform API Reference (1.0.0) - AtomCounters

Toggle Pane

• AtomCounters
  • postModifies or updates an AtomCounters object
  • getRetrieves an AtomCounters object by identifier
  • getRetrieves an AtomCounters object by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AtomCounters

The AtomCounters object represents the counters and their values associated with a particular Runtime. The owner of a Runtime, Cloud, or Runtime cluster can retrieve a list of all counters for their container. You can also modify counters' values by adding, changing, or removing a container's counters. The Runtime Counter value should be between 1 and 2147483647.

Retrieving a list of counters is an asynchronous process:

• The client sends a GET request that specifies a list of all a container's counters to the Boomi Platform.
• The platform returns a counter token for the specified Runtime, Runtime cluster, or Runtime cloud.
• The client sends one or more GET requests that include the counter token.
  • The platform returns one of the following:
    • Status code 202 while the request is in progress.
    • Status code 200, with the the list of the Runtime Counters, when the request is complete.

Required Privileges

You need these privileges in the target environment:

Read and Write access

• API — Use the Boomi Platform API to access account data.
• ATOM_MANAGEMENT — Configure and administer integration runtimes.

Modifies or updates an AtomCounters object

The UPDATE operation updates Runtime Counter values for a specific Runtime. Using the UPDATE operation overrides all settings set on the current counter. However, calling the UPDATE operation does not delete any existing counters that are not included in the AtomCounters object.

Authorizations:

basicAuth

path Parameters

id required

string A unique ID assigned by the system to the Runtime.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId	string A unique ID assigned by the system to the Runtime.
	Array of objects (Counter)

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId	string A unique ID assigned by the system to the Runtime.
	Array of objects (Counter)

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

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "3456789a-bcde-f012-3456-789abcdef012",
• "purgeHistoryDays": 90,
• "@type": "AtomCounters",
• "counter": [

  • {

    • "@type": "Counter",
    • "name": "counter1",
    • "value": 3

    },
  • {

    • "@type": "Counter",
    • "name": "counter2",
    • "value": 4

    }

  ],
• "atomId": "d63aaa92-4520-4592-b070-3487d0e03522"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AtomCounters",
• "counter": [

  • {

    • "@type": "Counter",
    • "name": "counter1",
    • "value": 3

    },
  • {

    • "@type": "Counter",
    • "name": "counter2",
    • "value": 4

    }

  ],
• "atomId": "d63aaa92-4520-4592-b070-3487d0e03522"

}

Retrieves an AtomCounters object by identifier

For a response, use the token from the initial GET response in a new request.

Authorizations:

basicAuth

path Parameters

token required

string Takes in the token from a previous call to return a result.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

responseStatusCode required	integer <int32>
numberOfResults	integer <int32>
	Array of objects (AtomCounters)

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}/async/AtomCounters/response/{token}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AsyncOperationResult",
• "result": [

  • {

    • "@type": "AtomCounters",
    • "atomId": "3456789a-bcde-f012-3456-789abcdef012",
    • "Counters": [

      • {

        • "Counter": [

          • {

            • "@type": "Counter",
            • "name": "counter1",
            • "value": "2"

            },
          • {

            • "@type": "Counter",
            • "name": "counter2",
            • "value": "1"

            }

          ]

        }

      ]

    }

  ],
• "responseStatusCode": "200",
• "numberOfResults": 1

}

Retrieves an AtomCounters object by identifier

The GET operation returns the current state of the counter names and values for the specified Runtime. The initial GET operation returns a token for the specified Runtime. accountId is the Platform account that you are authenticating with and id is the Runtime ID for the counters you are attempting to GET.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

required	object (AsyncToken)
responseStatusCode required	integer <int32>

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AsyncOperationResult",
• "responseStatusCode": 202,
• "asyncToken": {

  • "@type": "AsyncToken",
  • "token": "AtomCounters-abc123c4-a888-6789-8449-615e3cb58e5e"

  }

}