Publisher Integration Pack object

The PublisherIntegrationPack object represents the integration packs created in a parent or publisher account. Using the PublisherIntegrationPack object, you can retrieve details of integration packs and packaged components available to the publisher account.

You can perform the following operations using the Publisher Integration Pack object:

create, retrieve, update, query, and delete the integration packs
retrieve and update the packaged components

Structure

<PublisherIntegrationPack installationType="" name="" id="" operationType="">
    <Description></Description>
    <PublisherPackagedComponents>
        <PublisherPackagedComponent componentId="" componentName="" componentType="" currentVersion="" pendingVersion=""
            latestVersion="" deleted="" />
    </PublisherPackagedComponents>
</PublisherIntegrationPack>

Field	Type	Description
installationType	string	The type of integration pack. Possible values: SINGLE — single attachment MULTI — multiple attachment
name	string	The name of the integration pack.
id	string	A unique ID assigned by the system to the integration pack.
operationType	OperationType	Specifies the type of operation (ADD or DELETE) to perform when updating the packaged component to the integration pack. This field is mandatory for the Update operation and is not available for other operations.
Description	string	A description of the integration pack.
componentId	string	ID of the primary component in the packaged component.
componentName	string	Name of the primary component in the packaged component.
componentType	string	Component type of the primary component in the packaged component.
currentVersion	string	Packaged component version of the component that is currently released in this integration pack.
pendingVersion	string	Packaged component version of the component that will be included in the next release of this integration pack.
latestVersion	string	Latest packaged component version of the component that is available to be added to this integration pack.
deleted	Boolean	If true, the packaged component will be removed from the integration pack in the next release.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Supported	Supported	Supported	Not supported	Supported

Notes:

You can use the following fields as QUERY filters for the PublisherIntegrationPack object:

Field	Allowed values
installationType	SINGLE — single attachment or MULTI — multiple attachment
name	Any string value.
id	Any string value.

The operators allowed for the PublisherIntegrationPack object filters are:

BETWEEN
EQUALS
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
IS_NULL
IS_NOT_NULL
LESS_THAN
LESS_THAN_OR_EQUAL
NOT_EQUALS
CONTAINS
NOT_CONTAINS

Using the GET operation

Retrieves the details of the integration pack and packaged components. The standard GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves integration packs with the specified IDs to a maximum of 100.

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>PublisherIntegrationPack</api:objectType>
            <api:objectId>e222d28a-7262-4553-bf05-ef6617344540</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:PublisherIntegrationPack" id="b9875167-ddbd-4c5f-a77d-327589b52bf8" name="test multi" installationType="MULTI">
                <bns:Description></bns:Description>
                <bns:PublisherPackagedComponents>
                    <bns:PublisherPackagedComponent componentId="c7d8653d-81ff-4fcc-b814-49e148fc4024" componentName="Cleanse" componentType="process" currentVersion="" pendingVersion="cleanse process" latestVersion=""/>
                    <bns:PublisherPackagedComponent componentId="b2780aad-f5af-44e8-9b5b-f4823b363284" componentName="New Process 3" componentType="process" currentVersion="" pendingVersion="test" latestVersion=""/>
                </bns:PublisherPackagedComponents>
            </bns:result>
        </bns:getResponse>
    </S:Body>
</S:Envelope>

Using the CREATE operation

Creates a single attachment or multiple attachment 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:create>
        <object xsi:type="api:PublisherIntegrationPack" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          name="single_Ipack" installationType="SINGLE">
		<Description>first ipack</Description>
	   </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 xsi:type="bns:PublisherIntegrationPack" integrationPackId="a3c4917d-9622-4c5f-978c-0f02b5f5457a" id="09805cb6-3075-43a6-af76-cc07deeceb57" name="single_Ipack" installationType="SINGLE"><bns:Description>first ipack</bns:Description> </bns:result>
     </bns:createResponse>
  </S:Body>
</S:Envelope>

Using the UPDATE operation

The Update operation adds or removes the packaged components from the publisher integration pack. It also updates the description field of single and multiple attachment integration packs and the name field only for a single attachment integration pack.

note

When updating an integration pack, you must include all the packaged components associated with it in the request body. If a packaged component is not included, it will be deleted upon updating an integration pack. For example, include all packaged components while updating the integration pack name.

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:PublisherIntegrationPack" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          id="a97c3876-efb0-4b1c-93f7-91de3d9530bf" name="New update Ipack" installationType="SINGLE" operationType="ADD">
           <api:Description>single install ipack</api:Description>
           <api:PublisherPackagedComponents>
               <api:PublisherPackagedComponent componentId="b2780aad-f5af-44e8-9b5b-f4823b363284"/>
           </api:PublisherPackagedComponents>
         </object>
     </api:update>
  </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <result xsi:type="bns:PublisherIntegrationPack" id="a97c3876-efb0-4b1c-93f7-91de3d9530bf" name="New update Ipack" installationType="SINGLE">
                <bns:Description>single install ipack
                </bns:Description>
                <bns:PublisherPackagedComponents>
                    <bns:PublisherPackagedComponent componentId="b2780aad-f5af-44e8-9b5b-f4823b363284" componentName="New Process 3" componentType="process" currentVersion="" pendingVersion="test" latestVersion=""/>
                </bns:PublisherPackagedComponents>
            </result>
        </bns:updateResponse>
    </S:Body>
</S:Envelope>

Using the DELETE operation

Deletes the publisher integration pack having a specified ID from the requesting account. The deleted integration pack is automatically uninstalled from all accounts where it was installed. Any Runtimes or environments attached to the integration pack are also detached.

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>user@boomi.com</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:delete>
         <objectType>PublisherIntegrationPack</objectType>
         <objectId>caa4448d-6d54-4e9d-8d4b-78b581befc38</objectId>
      </api:delete>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:deleteResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <successful>true</successful>
        </bns:deleteResponse>
    </S:Body>
</S:Envelope>

Using the QUERY operation

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:query>
        <api:objectType>PublisherIntegrationPack</api:objectType>
        <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="EQUALS" property="installationType"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                  <api:argument>SINGLE</api:argument>
               </api:expression>
            </api:QueryFilter>
        </api:queryConfig>
     </api:query>
  </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results numberOfResults="3">
                <bns:result xsi:type="bns:PublisherIntegrationPack" id="664cc077-28a8-42cb-ac6e-1cb131c9e0d0" name="IPACK-JSON" installationType="SINGLE">
                    <bns:Description>Ipack description</bns:Description>
                    <bns:PublisherPackagedComponents/>
                </bns:result>
                <bns:result xsi:type="bns:PublisherIntegrationPack" id="8b80f83b-9836-49a0-8c72-753131a77bae" name="test single" installationType="SINGLE">
                    <bns:Description></bns:Description>
                    <bns:PublisherPackagedComponents>
                        <bns:PublisherPackagedComponent componentId="62f7ffb7-5332-4142-893a-8d40d4742ccf" componentName="Rate Limit Test" componentType="process" currentVersion="" pendingVersion="1.0" latestVersion=""/>
                        <bns:PublisherPackagedComponent componentId="bb0dae4f-c8f3-47fa-9dee-c3c484f79f71" componentName="New Process 4" componentType="process" currentVersion="" pendingVersion="3.0" latestVersion=""/>
                    </bns:PublisherPackagedComponents>
                </bns:result>
                <bns:result xsi:type="bns:PublisherIntegrationPack" id="e7b60a7c-559a-4904-9a52-d724f2d967b4" name="single_Ipack" installationType="SINGLE">
                    <bns:Description>description update</bns:Description>
                    <bns:PublisherPackagedComponents>
                        <bns:PublisherPackagedComponent componentId="6d7c05f6-cb29-41c7-8bac-b9e57b3b9783" componentName="New Process 7" componentType="process" currentVersion="" pendingVersion="1.0" latestVersion=""/>
                        <bns:PublisherPackagedComponent componentId="b2780aad-f5af-44e8-9b5b-f4823b363284" componentName="New Process 3" componentType="process" currentVersion="" pendingVersion="test" latestVersion="" deleted="true"/>
                        <bns:PublisherPackagedComponent componentId="c7d8653d-81ff-4fcc-b814-49e148fc4024" componentName="Cleanse" componentType="process" currentVersion="" pendingVersion="cleanse process" latestVersion=""/>
                    </bns:PublisherPackagedComponents>
                </bns:result>
            </bns:results>
        </bns:queryResponse>
    </S:Body>
</S:Envelope>

Structure​

Supported operations​

Using the GET operation​

Using the CREATE operation​

Using the UPDATE operation​

Using the DELETE operation​

Using the QUERY operation​

Structure

Supported operations

Using the GET operation

Using the CREATE operation

Using the UPDATE operation

Using the DELETE operation

Using the QUERY operation