Boomi Platform API Reference (1.0.0) - ReleaseIntegrationPack

Toggle Pane

• ReleaseIntegrationPack
  • postCreates a ReleaseIntegrationPack object
  • postModifies or updates a ReleaseIntegrationPack object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ReleaseIntegrationPack

The ReleaseIntegrationPack object represents the release object of the publisher integration pack.

• You can release (immediate or scheduled) a publisher integration pack using the Create operation.
• You can modify a scheduled release for an integration pack.

Required Privileges

Write access

• N/A

Read access

• API Publisher Integration Pack
• Integration Pack

Creates a ReleaseIntegrationPack object

Creates an immediate or scheduled release for a publisher integration pack.

To schedule the publisher integration pack for release, you must specify the release schedule (immediate or scheduled). The releaseOnDate field is required if you schedule the release for a future date.

Note: When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the User Information panel within the Settings page. Setting the time zone ensures the scheduled date is displayed correctly in the UI.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (ReleasePackagedComponents)
id	string The ID of the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
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
releaseStatusUrl	string The complete endpoint URL used to make a second call to the ReleaseIntegrationPackStatus object. It is provided for your convenience in the releaseStatusUrl field of the initial POST response.
requestId	string A unique ID assigned by the system to the integration pack release request.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (ReleasePackagedComponents)
id	string The ID of the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
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
releaseStatusUrl	string The complete endpoint URL used to make a second call to the ReleaseIntegrationPackStatus object. It is provided for your convenience in the releaseStatusUrl field of the initial POST response.
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}/ReleaseIntegrationPack

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
• "name": "Testing Multi",
• "installationType": "MULTI",
• "releaseSchedule": "IMMEDIATELY",
• "ReleasePackagedComponents": {

  • "ReleasePackagedComponent": [

    • {

      • "componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
      • "version": "2.0"

      }

    ]

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ReleaseIntegrationPack",
• "id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
• "installationType": "MULTI",
• "name": "Testing Multi",
• "releaseSchedule": "IMMEDIATELY",
• "requestId": "release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
• "releaseStatusUrl": "https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
• "releaseOnDate": "2025-02-20",
• "ReleasePackagedComponents": {

  • "ReleasePackagedComponent": [

    • {

      • "componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
      • "releasedVersion": "1.0",
      • "version": "1.0"

      }

    ]

  }

}

Modifies or updates a ReleaseIntegrationPack object

Modifies the scheduled release of a publisher integration pack.

The Update operation is only performed when there is an existing scheduled release request for the integration pack.

Note: When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the User Information panel within the Settings page. Setting the time zone ensures the scheduled date is displayed correctly in the UI.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	object (ReleasePackagedComponents)
id	string The ID of the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
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
releaseStatusUrl	string The complete endpoint URL used to make a second call to the ReleaseIntegrationPackStatus object. It is provided for your convenience in the releaseStatusUrl field of the initial POST response.
requestId	string A unique ID assigned by the system to the integration pack release request.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	object (ReleasePackagedComponents)
id	string The ID of the integration pack.
installationType	string Enum: "SINGLE" "MULTI" The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
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
releaseStatusUrl	string The complete endpoint URL used to make a second call to the ReleaseIntegrationPackStatus object. It is provided for your convenience in the releaseStatusUrl field of the initial POST response.
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}/ReleaseIntegrationPack/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
• "name": "Testing Multi",
• "installationType": "MULTI",
• "releaseSchedule": "IMMEDIATELY",
• "ReleasePackagedComponents": {

  • "ReleasePackagedComponent": [

    • {

      • "componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
      • "releasedVersion": "1.0",
      • "version": "1.0"

      }

    ]

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ReleaseIntegrationPack",
• "id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
• "installationType": "MULTI",
• "name": "Testing Multi",
• "releaseSchedule": "IMMEDIATELY",
• "requestId": "release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
• "releaseStatusUrl": "https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
• "releaseOnDate": "2025-02-20",
• "ReleasePackagedComponents": {

  • "ReleasePackagedComponent": [

    • {

      • "componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
      • "releasedVersion": "1.0",
      • "version": "1.0"

      }

    ]

  }

}