Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ConnectionLicensingReport

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ConnectionLicensingReport

The Connection Licensing operation provides a detailed response to the Test and Production connector classes that have been deployed to one or more environments. You can programatically download and view detailed reports for each connector class. The Connection Licensing operation is a two-step asynchronous process:

  1. The User first sends a CREATE request to the Boomi Enterprise Platform, with a request body that specifies with our without filters.
    • The Enterprise platform returns the Connection Licensing URL in the response to view or download the deployed connection details.
  2. The User invokes the GET API call with the URL returned in Step 1 to download or view the data. The Boomi Enterprise Platform will return an HTTP 202 status code until the data is ready.

    Note: An account can accept ONLY one request at a time. In order to CREATE a new request, the Client or User has to download or view the previous requested details with the GET API. If not, in the next CREATE request, the response returned will have the previous request URL to download or view the details, which allows users to make a new CREATE request.

Download the Connection Licensing Report

ConnectionLicensingReport call

Send an HTTP GET using the URL returned in the CREATE request to download the detailed connection licensing report in the CSV format.

GET API URL:

https://api.boomi.com/account/<accountId>/api/download/ConnectionLicensing<ConnectionLicensingID>ConnectionLicensing-<ConnectionLicensingID>

where accountId is the ID of the authenticating account for the request and ConnectionLicensingID is the GUID of the created request for the connection licensing report you want to view. To download the CSV report, make a GET API call and select the Send and Download option in the Postman.

This URL is valid until it is invoked. Once the GET API is invoked the URL becomes inactive.

GET API Response:

"Deployed Connection Licensing Report for admin-123 20230809143136"

"ENVIRONMENT\_ID","ENVIRONMENT\_NAME","ENVIRONMENT\_CLASS","CONTAINER\_ID","CONTAINER\_NAME","COMPONENT\_ID","CONNECTOR\_TYPE","CONNECTOR\_CLASS","COMPONENT\_NAME","COMPONENT\_FOLDER\_ID","COMPONENT\_FOLDER\_PATH"

"d0412cc3-52ad-4ae3-ad4e-687dd4d7715e","Production\_Env","PROD","e1282939-ff19-42c4-83a2-f2c1f4c8ac3e","Mini\_Atom","66c0d1d2-82d5-46b4-b965-cd670425b536","ebs","Enterprise","New Oracle E-Business \(new\) Connection","RjoxMzA5MzUx","minalrathod/TBD/TBD-connectors"

"149dd86a-0e7d-48d8-bae3-b88b0f8ae474","MinalLocalEnv","TEST","9055857b-5020-4580-9557-e6a42185dbd1","Local\_Atom","3be9f2b8-4729-4ad3-850b-fe1eff64ed31","sapjco","Enterprise","SAP RAC","Rjo5MzM1Mzg","FolderA"

Note: You cannot invoke GET API directly. The GUID passed in the URL must be the ID that was returned in the CREATE request.

Download request responses

The download URL returned in the CREATE request, such as https://api.platform.boomi.com/account/admin-123/api/download/ConnectionLicensing-bdc1d9f7-1158-4062-8a13-63e5276f3b52, is valid for a single request. The URL becomes inactive if it is already invoked. The following are the possible responses to an HTTP request when downloading or viewing the deployed connection details:

  • 200 (OK) - The download is complete. The downloaded log is in the response body.

    All subsequent requests to open the download URL returns 404 (Not Found).

  • 202 (Accepted) - The download is in progress.

    Before returning a final download response, you might receive multiple 202 responses.

  • 204 (No Content) - Log data is not available.

    All subsequent requests to open the download URL returns 404 (Not Found).

  • 404 (Not Found) - A 200, 204, or 504 response was returned from a previous request to open this URL.

  • 504 (Gateway Timeout) - The Runtime is unavailable. It might have timed out.

    All subsequent requests to open the download URL returns 404 (Not Found).

Known Limitations

These are the known limitations:

  • The Deployed count and the CSV report count may or may not match. This is because the same connection might be used in multiple processes; therefore, the report contains an entry for each deployed process where the connection has been used.

  • For invoking the SOAP requests, along with the Licensing privilege, users must have API Access privilege for creating the SOAP requests.

Creates a ConnectionLicensingReport object

Returns the Connection Licensing URL in the response to view or download the deployed connection details. To download connection licensing data for a given connector class:

a. Send a POST and request body to https://api.boomi.com/api/rest/v1/<accountId>/ConnectionLicensingReport

where accountId is the ID of the authenticating account for the request.

Populate the request body with or without the available filters for the report that you want to download.

b. Next, send a GET request using the URL returned in the POST response. The GET does not require a request body, and returns the deployed connection details.

Note: Do not pass any filters in the CREATE payload. This will not help get the Test & Production connections deployed details for all the connector classes. To get the Test and Production deployed connection details you have to pass ONLY the structure in the CREATE request, without any filters.

  • To apply multiple filters, add the Operator to the payload. Refer to the provided code samples for guidance.

  • The argument values for the property filters in the CREATE payload should be:

  • componentId - Must be a valid componentId value. If an invalid value is passed, the report or the GET response will be blank or will have zero records.

  • environmentId - Must be valid environmentId value. If an invalid value is passed, the report or the GET response will be blank or will have zero records.

  • containerId - Must be a valid atomId or moleculeId. If an invalid value is passed, the report or the GET response will be blank or will have zero records.

  • connectorClass - Must be valid connectorClass. Values must be either Standard, Small Business, Trading Partner, or Enterprise.

Authorizations:
basicAuth
Request Body schema:
optional
required
object (QueryFilter)
expression
required
object (Expression)

Responses

Response Schema:
url
string

URL to view or download the deployed connection details.

message
string
statusCode
string

Request samples

Content type
{
  • "@type": "ConnectionLicensingReport",
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{}