Boomi Platform API Reference (1.0.0) - AtomConnectorVersions

Toggle Pane

• AtomConnectorVersions
  • getRetrieves an instance of an AtomConnectorVersions object
  • postRetrieves multiple AtomConnectorVersions objects by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

AtomConnectorVersions

The Atom Connector Versions object represents the properties of connectors that are used by a Runtime, Runtime cluster, or Runtime cloud.

Required Privileges

You need these privileges in the target environment:

Write access

• N/A

Read access

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

Retrieves an instance of an AtomConnectorVersions object

Retrieves the properties of connectors used by the Runtime, Runtime cluster, or Runtime cloud with specified ID.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the Runtime, Runtime cluster, or Runtime cloud.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects (ConnectorVersion) Each pair of name and version fields represents a connector listed on the Runtime Management page > Runtime & Connector Versions tab.
id	string The ID of the Runtime, Runtime cluster, or Runtime cloud.

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AtomConnectorVersions",
• "ConnectorVersion": [

  • {

    • "@type": "ConnectorVersion",
    • "name": "Disk",
    • "version": "16.06.2-20160512.140052-1"

    },
  • {

    • "@type": "ConnectorVersion",
    • "name": "Atom",
    • "version": "16.06.2-20160511.102900-1"

    },
  • {

    • "@type": "ConnectorVersion",
    • "name": "Platform API",
    • "version": "16.06.2-20160510.100150-1"

    },
  • {

    • "@type": "ConnectorVersion",
    • "name": "Platform Partner API",
    • "version": "16.06.2-20160509.150052-2"

    }

  ],
• "id": "3456789a-bcde-f012-3456-789abcdef012"

}

Retrieves multiple AtomConnectorVersions 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 (AtomConnectorVersions) 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}/AtomConnectorVersions/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": {

      • "ConnectorVersion": [

        • {

          • "name": "string",
          • "version": "string"

          }

        ],
      • "id": "3456789a-bcde-f012-3456-789abcdef012"

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

    }

  ]

}