Release Integration Pack Status object
Retrieves the status of the publisher integration pack scheduled for the release.
Structure
<ReleaseIntegrationPackStatus integrationPackId="" installationType="" name="" requestId="" releaseSchedule="" releaseOnDate="" releaseStatus="">
<ReleasePackagedComponents>
<ReleasePackagedComponent componentId="" releasedVersion=""/>
<ReleasePackagedComponents>
</ReleaseIntegrationPackStatus>
| Field | Type | Description |
|---|---|---|
| integrationPackId | string | A unique ID assigned by the system to the integration pack. |
| installationType | string | The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment |
| releaseSchedule | ReleaseIntegrationScheduleType | Specify the type of release schedule for the integration pack. Possible values: IMMEDIATELY — for immediate release RELEASE_ON_SPECIFIED_DATE — for future release |
| name | string | The name of the integration pack. |
| id | string | The ID of the integration pack. |
| releaseOnDate | string | Date for future release of integration pack Date Format: yyyy-MM-dd |
| requestId | string | A unique ID assigned by the system to the integration pack release request. |
| releaseStatusUrl | string | The 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. |
| releaseStatus | ReleaseStatusType | The type of release status. Possible values:
|
| ReleasePackagedComponents | List | List of packaged components which are released. |
| componentId | string | ID of the primary component in the packaged component. |
| releasedVersion | string | The released version of the packaged component. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
Using the GET operation
To retrieve the release status of the publisher integration pack, follow these steps:
- Send a POST request to the ReleaseIntegrationPackStatus object. The response will return a requestId.
- 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.
- 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.
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:get>
<api:objectType>ReleaseIntegrationPackStatus</api:objectType>
<api:objectId>release-0dc390be-96de-4c58-b0c4-53aa7f98ce77</api:objectId>
</api:get>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:getResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
<bns:result xsi:type="bns:ReleaseIntegrationPackStatus" 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">
<bns:ReleasePackagedComponents>
<bns:ReleasePackagedComponent componentId="e48fc23c-4f4b-4c70-9d7b-418a7743b415" releasedVersion="1.0"/>
<bns:ReleasePackagedComponent componentId="5dcb2510-a00a-4897-a7a8-c69c58ab91e4" releasedVersion="1.0"/>
</bns:ReleasePackagedComponents>
</bns:result>
</bns:getResponse>
</S:Body>
</S:Envelope>
Was this topic helpful?