Waiting for engine...
Skip to main content

Release Integration Pack object

The Release Integration Pack 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.

Structure

<ReleaseIntegrationPack installationType="" name="" id="" releaseSchedule="" releaseOnDate=""  requestId="" releaseStatusUrl="">
<ReleasePackagedComponents>
<ReleasePackagedComponent componentId="" version=""/>
</ReleasePackagedComponents>
</ReleaseIntegrationPack>
FieldTypeDescription
installationTypestringThe type of integration pack. Possible values:
SINGLE — single attachment
MULTI — multiple attachment
releaseScheduleReleaseIntegrationScheduleTypeSpecify the type of release schedule for the integration pack. Possible values:
IMMEDIATELY — for immediate release
RELEASE_ON_SPECIFIED_DATE — for future release
namestringThe name of the integration pack.
idstringThe ID of the integration pack.
releaseOnDatestringDate for future release of integration pack
Date Format: yyyy-MM-dd
requestIdstringA unique ID assigned by the system to the integration pack release request.
releaseStatusUrlstringThe complete endpoint URL used to make a second call to the Release Integration Pack Status object. It is provided for your convenience in the releaseStatusUrl field of the initial POST response.
ReleasePackagedComponentsListList of packaged components which are released
componentIdstringID of the primary component in the packaged component.
versionstringPackaged component version of the component that will be included in the next release of this integration pack.

Supported operations

GETQUERYCREATEUPDATEEXECUTEDELETE
Not supportedNot supportedSupportedSupportedNot supportedNot supported
info

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.

Using the CREATE operation

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.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>BOOMI_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:create>
<object xsi:type="api:ReleaseIntegrationPack" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="f0f7face-3a9d-48b1-8a32-82b84499cd4e" releaseSchedule="IMMEDIATELY">
<api:ReleasePackagedComponents>
<api:ReleasePackagedComponent componentId="b420a8ab-8e4e-41b2-93ce-079093a03af2" version="2.0"/>
</api:ReleasePackagedComponents>
</object>
</api:create>
</soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/"
id="f0f7face-3a9d-48b1-8a32-82b84499cd4e" installationType="MULTI" name="Testing Multi" releaseSchedule="IMMEDIATELY" requestId="release-0d3ad8c1-9906-49f0-a9a5-f1c773826857" releaseStatusUrl="https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-0d3ad8c1-9906-49f0-a9a5-f1c773826857"/>
</bns:createResponse>
</S:Body>
</S:Envelope>

Using the UPDATE operation

Modifies the scheduled release of a publisher integration pack.

note

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

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>BOOMI_USER_NAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">BOOMI_PASSWORD</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:update>
<object xsi:type="api:ReleaseIntegrationPack" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="f0f7face-3a9d-48b1-8a32-82b84499cd4e" releaseSchedule="RELEASE_ON_SPECIFIED_DATE" releaseOnDate="2025-12-20">
<api:ReleasePackagedComponents>
<api:ReleasePackagedComponent componentId="b420a8ab-8e4e-41b2-93ce-079093a03af2" version="1.0"/>
</api:ReleasePackagedComponents>
</object>
</api:update>
</soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/"
id="f0f7face-3a9d-48b1-8a32-82b84499cd4e" installationType="MULTI" name="Testing Multi" releaseSchedule="RELEASE_ON_SPECIFIED_DATE" releaseOnDate="2025-12-20" requestId="release-0d3ad8c1-9906-49f0-a9a5-f1c773826869" releaseStatusUrl="https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-0d3ad8c1-9906-49f0-a9a5-f1c773826869"/>
</bns:updateResponse>
</S:Body>
</S:Envelope>
On this Page