Integration Pack object

The Integration Pack object represents an integration pack. You can query the Integration Pack object to determine the integration packs available to a secondary account

This object does not return the integration packs created in the primary or publisher account.

Structure

<IntegrationPack installationType="" name="" id="">
   <Description></Description>
</IntegrationPack>

Field	Type	Description
installationType	IntegrationPackType	The type of integration pack. Possible values: - SINGLE — single-attach - MULTI — multi-attach
name	string	The name of the integration pack.
id	string	A unique ID assigned by the system to the integration pack.
Description	string	A description of the integration pack.

Supported operations

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

Notes:

• The ordinary GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves the properties of the integration packs having the specified IDs, to a maximum of 100.

• You can use the following fields as QUERY filters for the Integration Pack object.

  Field	Allowed values
  installationType	SINGLE(single-attach) or MULTI (multi-attach).
  name	Any string value.
  id	Any string value.

  The operators allowed for the Integration Pack 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

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>IntegrationPack</api:objectType>
           <api:objectId>89abcdef-0123-4567-89ab-cdef01234567</api:objectId>
        </api:get>
     </soapenv:Body>
  </soapenv:Envelope>

  Response:

  <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
        <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <bns:result xsi:type="bns:IntegrationPack" installationType="SINGLE" name="Order Intake" 
              id="89abcdef-0123-4567-89ab-cdef01234567"> 
               <bns:Description>Order Intake Ipack</bns:Description>
           </bns:result>
        </bns:getResponse>
     </S:Body>
  </S:Envelope>

• QUERY operation

  The following example query returns all single-install integration packs available to 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>IntegrationPack</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:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
           <bns:results numberOfResults="2">
               <bns:result xsi:type="bns:IntegrationPack" installationType="SINGLE" name="Order Intake" 
                 id="89abcdef-0123-4567-89ab-cdef01234567">
                  <bns:Description>Order Intake Ipack</bns:Description>
               </bns:result>
               <bns:result xsi:type="bns:IntegrationPack" installationType="SINGLE" name="Order Processing" 
                 id="76543210-fedc-ba98-7654-3210fedcba98">
                  <bns:Description>Order Processing Ipack</bns:Description>
               </bns:result>
           </bns:results>
       </bns:queryResponse>
     </S:Body>
  </S:Envelope>