Integration Pack Instance object

The Integration Pack Instance object represents an installed instance of an integration pack. You can query this object to find an account's installed integration pack instances and details of processes associated with instances.

Structure

<IntegrationPackInstance id="" integrationPackOverrideName="" integrationPackId="">
 <ProcessId originalProcessId="" wrapperProcessId="" name=""/>
</IntegrationPackInstance>

Field	Type	Description
id	string	A unique ID assigned by the system to the installed instance of the integration pack. This field populates only if you install the integration pack in the requesting account.
integrationPackOverrideName	string	The name of the installed instance of the integration pack. You can set this value only in the case of multi-install integration packs; its purpose is to distinguish between instances.
integrationPackId	string	A unique ID assigned by the system to the integration pack.
ProcessId	list	A list of process IDs associated with the integration pack instance
originalProcessId	string	A unique ID assigned by the system when the process is created.
wrapperProcessId	string	A unique ID assigned to each process associated with multi-install integration packs. A wrapperProcessId is generated when an IntegrationPackInstance is installed or created. Note: The `wrapperProcessId` will not be returned for the single-install integration pack while making API calls, as it is only generated for the multi-install integration packs.
name	string	The name of the process.

Supported operations

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

Notes:

The ordinary GET operation retrieves the properties of the integration pack instance having the specified ID. The bulk GET operation retrieves the properties of the integration pack instances having the specified IDs, to a maximum of 100. You can obtain integration pack instance IDs from the QUERY operation.
You can use the following fields as QUERY filters for the Integration Pack Instance object:

Field Allowed values
integrationPackId Any string value.
integrationPackName Any string value.
integrationPackOverrideName Any string value.

The operators allowed for the Integration Pack Instance object filters are:
- BETWEEN
- EQUALS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- IS_NULL
- IS_NOT_NULL
- LESS_THAN
- LESS_THAN_OR_EQUAL
- LIKE
- NOT_EQUALS
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
The CREATE operation installs an instance of the integration pack with a specific ID in the requesting account. You can set the integrationPackOverrideName field only if you configure the specified integration pack to allow multiple installs.
The DELETE operation uninstalls the integration pack instance having a specified ID from the requesting account. You can obtain this ID from a QUERY operation.

Field	Allowed values
integrationPackId	Any string value.
integrationPackName	Any string value.
integrationPackOverrideName	Any string value.

SOAP implementation

GET 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>ATOMSPHERE_USER_NAME</wsse:Username>
     <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
   </wsse:UsernameToken>
 </wsse:Security>
 </soapenv:Header>
 <soapenv:Body>
   <api:get>
    <api:objectType>IntegrationPackInstance</api:objectType>
    <api:objectId>76543210FEDCBA9876543210FEDCBA98</api:objectId>
   </api:get>
 </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <bns:IntegrationPackInstance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" integrationPackId="89abcdef-0123-4567-89ab-cdef01234567" integrationPackOverrideName="Domestic Order Intake" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UyMA">
     <bns:ProcessId originalProcessId="bc407c7d-cacc-48da-a430-c6a4d2835a83" wrapperProcessId="0331193a-2675-4f33-97fc-e050a4fd4eec" name="Domestic Order Intake - INT"/>
    </bns:IntegrationPackInstance>
  </S:Body>
</S:Envelope>

QUERY operation

The following example query returns all instances of the integration packs whose given name is Order Intake installed in the requesting account.

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>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:query>
         <api:objectType>IntegrationPackInstance</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression operator="EQUALS" property="integrationPackName"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                   <api:argument>Order Intake</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:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="2">
             <bns:result xsi:type="bns:IntegrationPackInstance" id="76543210FEDCBA9876543210FEDCBA98" 
               integrationPackOverrideName="Domestic Order Intake" integrationPackId="89abcdef-0123-4567-89ab-cdef01234567"/> 
             <bns:result xsi:type="bns:IntegrationPackInstance" id="876543210FEDCBA9876543210FEDCBA9" 
               integrationPackOverrideName="International Order Intake" integrationPackId="89abcdef-0123-4567-89ab-cdef01234567"/> 
         </bns:results>
     </bns:queryResponse>
   </S:Body>
</S:Envelope>

CREATE 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>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create>
         <object xsi:type="api:IntegrationPackInstance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           integrationPackOverrideName="Domestic Order Processing" integrationPackId="89abcdef-0123-4567-89ab-cdef01234567"/>
      </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:IntegrationPackInstance" integrationPackId="89abcdef-0123-4567-89ab-cdef01234567" integrationPackOverrideName="Domestic Order Intake" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxNg">
         <bns:ProcessId originalProcessId="bc407c7d-cacc-48da-a430-c6a4d2835a83" wrapperProcessId="e1da73ea-bfb7-4083-b1b5-dcf797f52a77" name="Domestic Order Intake - INT-11311"/>
         <bns:ProcessId originalProcessId="f23ce1b1-7440-4535-a534-685a17a41607" wrapperProcessId="f12ba29e-e688-4f0f-b7d6-9917a51e5b39" name="Domestic Order Intake - New Process 3"/> </bns:result>
       <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="a3c4917d-9622-4c5f-978c-0f02b5f5457a" integrationPackOverrideName="Domestic Order Intake" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxNw">
         <bns:ProcessId originalProcessId="bc407c7d-cacc-48da-a430-c6a4d2835a83" wrapperProcessId="b73236e9-a7af-4401-bc0c-0805a057d504" name="Domestic Order Intake - INT-11311"/>
         <bns:ProcessId originalProcessId="f23ce1b1-7440-4535-a534-685a17a41607" wrapperProcessId="5bdaf4a1-314b-4964-8787-1edb060f79ca" name="Domestic Order Intake - New Process 3"/> </bns:result>
   </bns:createResponse>
  </S:Body>
</S:Envelope>

DELETE 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>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:delete>
         <objectType>IntegrationPackInstance</objectType>
         <objectId>76543210FEDCBA9876543210FEDCBA98</objectId>
      </api:delete>
   </soapenv:Body>
</soapenv:Envelope>

Response:

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

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation