Boomi Platform API Reference (1.0.0) - ReleaseIntegrationPackStatus

Toggle Pane

• ReleaseIntegrationPackStatus
  • getRetrieves an instance of a ReleaseIntegrationPackStatus object
  • postRetrieves multiple ReleaseIntegrationPackStatus objects by identifier

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ReleaseIntegrationPackStatus

Retrieves the status of the publisher integration pack scheduled for the release.

Required Privileges

Write access

• API Publisher Integration Pack
• Integration Pack

Read access

• N/A

Retrieves an instance of a ReleaseIntegrationPackStatus object

To retrieve the release status of the publisher integration pack, follow these steps:

1. Send a POST request to the ReleaseIntegrationPackStatus object. The response will return a requestId.
2. Use the requestId returned in Step 1 to make a subsequent call to the ReleaseIntegrationPackStatus object to retrieve detailed information about the released integration pack.
3. Repeatedly poll the ReleaseIntegrationPackStatus object using the requestId until the details of the released integration pack are available. If the request is still in progress or scheduled, it returns an HTTP 202 status code. When the integration pack is released successfully, the ReleaseIntegrationPackStatus object returns the released details.

Authorizations:

basicAuth

path Parameters

id required

string A unique ID assigned by the system to the integration pack.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

responseStatusCode required	integer <int32>
	object (ReleasePackagedComponents)
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
integrationPackId	string A unique ID assigned by the system to the integration pack.
name	string The name of the integration pack.
releaseOnDate	string Date for future release of integration pack. Date Format: yyyy-MM-dd
releaseSchedule	string Enum: "IMMEDIATELY" "RELEASE_ON_SPECIFIED_DATE" Specify the type of release schedule for the integration pack. Possible values: IMMEDIATELY — for immediate release RELEASE_ON_SPECIFIED_DATE — for future release
releaseStatus	string Enum: "IN_PROGRESS" "SUCCESS" "SCHEDULED" "ERROR" The type of release Status. Possible values: INPROGRESS — for currently releasing integration pack SUCCESS — for successfully released integration pack SCHEDULED — for future release integration pack ERROR — for any error resulting in the release
requestId	string A unique ID assigned by the system to the integration pack release request.

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

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ReleaseIntegrationPackStatus",
• "ReleasePackagedComponents": {

  • "@type": "ReleasePackagedComponents",
  • "ReleasePackagedComponent": [

    • {

      • "@type": "ReleasePackagedComponent",
      • "componentId": "bb8b6c9d-9c39-4309-b07f-cdd96d201b27",
      • "releasedVersion": "1.0"

      },
    • {

      • "@type": "ReleasePackagedComponent",
      • "componentId": "9d05717c-4dfe-4d5f-8e60-9196a6f78ef9",
      • "releasedVersion": "1.0",
      • "version": "2.0"

      }

    ]

  },
• "responseStatusCode": 200,
• "integrationPackId": "d7c16f5d-3311-417e-a149-3c55436f7d8d",
• "name": "perf testing ipack",
• "installationType": "MULTI",
• "releaseSchedule": "IMMEDIATELY",
• "requestId": "release-dcfbfd2c-09d9-492d-9965-bbd9ab8f2ffc",
• "releaseStatus": "SUCCESS",
• "releaseOnDate": "2025-02-20"

}

Retrieves multiple ReleaseIntegrationPackStatus objects by identifier

The bulk GET operation returns multiple objects based on the supplied account IDs, to a maximum of 100. To learn more about bulk, refer to 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/xmlapplication/jsonapplication/xml

	Array of objects
Array required object (ReleaseIntegrationPackStatus) 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}/ReleaseIntegrationPackStatus/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/xmlapplication/jsonapplication/xml

No sample