Waiting for engine...
Skip to main content

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="" createdDate="">
 <ProcessId originalProcessId="" wrapperProcessId="" name=""/>
</IntegrationPackInstance>

FieldTypeDescription
idstringA 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.
integrationPackOverrideNamestringThe 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.
integrationPackIdstringA unique ID assigned by the system to the integration pack.
createdDatedateTime, for example yyyy-MM-dd'T'HH:mm:ss'Z'The date and time the integration pack instance was created. For example, 2026-07-22T20:44:25Z.
ProcessIdlistA list of process IDs associated with the integration pack instance
originalProcessIdstringA unique ID assigned by the system when the process is created.
wrapperProcessIdstringA 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.
namestringThe name of the process.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
 SupportedSupported  Supported Not supportedNot 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:

    FieldAllowed values
    integrationPackIdAny string value.
    integrationPackNameAny string value.
    integrationPackOverrideNameAny string value.
    createdDateDate with the format yyyy-MM-dd'T'HH:mm:ss'Z'.

    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.

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:

    <?xml version='1.0' encoding='UTF-8'?>
    <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:IntegrationPackInstance" integrationPackId="a295dc87-0092-4299-8135-05bfbebf810a" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4Ng" createdDate="2026-07-22T20:44:25Z">
                    <bns:ProcessId originalProcessId="4aa6a109-33af-4e4f-a084-32f9eb9f986e" name="JSON XML Cross Map Test Process"/>
                </bns:result>
            </bns:getResponse>
        </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:

    <?xml version='1.0' encoding='UTF-8'?>
    <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="19">
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="1465b907-e479-4dd9-9113-a018a7506d70" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U3"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="57f7acf2-5bfc-4c55-96fe-e2c6878b3b60" integrationPackOverrideName="Test Override 1" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxMQ" createdDate="2026-07-07T21:18:38Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fbf58e4f-c0b7-4d58-9865-57dc8546b092" integrationPackOverrideName="Process Properties MultiInstall IPack" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxMg" createdDate="2026-07-07T21:41:37Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fbf58e4f-c0b7-4d58-9865-57dc8546b092" integrationPackOverrideName="Test Override 1" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxMw" createdDate="2026-07-07T21:42:25Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fbf58e4f-c0b7-4d58-9865-57dc8546b092" integrationPackOverrideName="Test Override 1" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxNA" createdDate="2026-07-07T21:42:27Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="84c6c83a-2fd2-4b2e-84f5-a058f169fb3f" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxNg" createdDate="2026-07-08T13:53:56Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fbf58e4f-c0b7-4d58-9865-57dc8546b092" integrationPackOverrideName="Process Properties MultiInstall IPack 2" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UxNw" createdDate="2026-07-08T14:42:46Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fbf58e4f-c0b7-4d58-9865-57dc8546b092" integrationPackOverrideName="Process Properties MultiInstall IPack 3" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4Mw" createdDate="2026-07-08T17:57:09Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="ff206be7-2b43-49c3-bae5-5076c3cfddd2" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4NA" createdDate="2026-07-16T20:25:07Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="a295dc87-0092-4299-8135-05bfbebf810a" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4Ng" createdDate="2026-07-22T20:44:25Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="ce4a5d49-cde3-4349-a988-3fd46dafc470" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4Nw" createdDate="2026-07-24T02:14:37Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="d8864690-8ac8-49af-98a4-5bf70b53b3e3" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U4OA" createdDate="2026-07-24T02:14:42Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="fac52c39-6072-46f5-b51e-1151f2d8d0d0" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5MA" createdDate="2026-07-27T04:47:34Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="702249a9-bd9d-4803-9d80-8e4d40fe5dad" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5MQ" createdDate="2026-07-29T17:44:51Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="e14ee250-0ca5-4808-a75d-4c3f1fe2a94a" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5Mg" createdDate="2026-07-29T18:11:01Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="550e082d-31c2-4db1-ac21-ace6315a4258" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5Mw" createdDate="2026-08-06T19:03:07Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="c98627f3-efe2-45be-b2f8-f1de64ad5e6e" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5NA" createdDate="2026-08-07T14:34:53Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="48e139e9-9927-4df8-967d-a0f35ed9e752" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5NQ" createdDate="2026-08-13T20:20:43Z"/>
                    <bns:result xsi:type="bns:IntegrationPackInstance" integrationPackId="842378d6-3444-479e-ad69-c9991c966d93" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5Ng" createdDate="2026-08-20T20:18:25Z"/>
                </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="INT-17352 Multi reinstall for 17341" integrationPackId="2955c04e-f60f-496f-9ef4-830420ad1018"/>
          </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="2955c04e-f60f-496f-9ef4-830420ad1018" integrationPackOverrideName="INT-17352 Multi reinstall for 17341" id="SW50ZWdyYXRpb25QYWNrSW5zdGFuY2U5Mg" createdDate="2026-07-21T15:45:05.750Z">
             <bns:ProcessId originalProcessId="02367a58-6d48-47cf-8e10-3d9280f64b19" wrapperProcessId="1a87f6a0-ca8b-48e5-8d50-f62b4b68fdd0" name="INT-17352 Multi reinstall for 17341 - 17352 - Boomi Platform Connection Process"/>
             <bns:ProcessId originalProcessId="7ee2fb46-003f-498e-acfd-f92cd560951e" wrapperProcessId="4b060220-1aa2-44b6-bfd4-c55aeb0f2dbe" name="INT-17352 Multi reinstall for 17341 - 17352 - HTTP Client Connection Process"/>
             <bns:ProcessId originalProcessId="f09455bd-13ce-48ad-b312-a63f9e5be085" wrapperProcessId="2d71f2cb-f33d-4d38-b7eb-dd16fd3ca22d" name="INT-17352 Multi reinstall for 17341 - 17352 - QuickBooks Online Connection Process"/>
           </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>

On this Page