Integration Pack Environment Attachment object

The Integration Pack Environment Attachment object enables the attachment or detachment of an integration pack instance to or from a particular environment.

note

The Integration Pack Environment Attachment object type is exposed only for accounts where you enable environments. For accounts where you do not enable environments, it reveals the Integration Pack Atom Attachment object type instead.

Structure

<IntegrationPackEnvironmentAttachment id="" environmentId="" integrationPackInstanceId=""/>

Field	Type	Description
id	string	The object’s conceptual ID, which is synthesized from the environment and integration pack instance IDs.
environmentId	string	A unique ID assigned by the system to the environment.
integrationPackInstanceId	string	A unique ID assigned by the system to the integration pack instance.

Supported operations

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

Notes:

You can use the following fields as QUERY filters for the Integration Pack Environment Attachment object:

Field Allowed values
environmentId Any string value.
integrationPackInstanceId Any string value.

The operators allowed for the Integration Pack Environment Attachment 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 attaches an integration pack instance having the specified ID to the environment having the specified ID.
The DELETE operation detaches an integration pack instance from an environment where the conceptual Integration Pack Environment Attachment object ID specifies the attachment.

Field	Allowed values
environmentId	Any string value.
integrationPackInstanceId	Any string value.

SOAP implementation

QUERY operation

The following example query returns the integration pack instances attached to the environment whose ID is 456789ab-cdef-0123-4567-89abcdef0123.

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>IntegrationPackEnvironmentAttachment</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
               <api:expression operator="EQUALS" property="environmentId"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                   <api:argument>456789ab-cdef-0123-4567-89abcdef0123</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:IntegrationPackEnvironmentAttachment" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg" 
              environmentId="456789ab-cdef-0123-4567-89abcdef0123" integrationPackInstanceId="76543210FEDCBA9876543210FEDCBA98"/>
            <bns:result xsi:type="bns:IntegrationPackEnvironmentAttachment" id="b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA" 
              environmentId="456789ab-cdef-0123-4567-89abcdef0123" integrationPackInstanceId="876543210FEDCBA9876543210FEDCBA9"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

CREATE operation

This example attaches the integration pack instance with ID 76543210FEDCBA9876543210fedcba98 to the environment with ID 456789a-bcde-f012-3456-789abcdef0123.

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:IntegrationPackEnvironmentAttachment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             environmentId="456789ab-cdef-0123-4567-89abcdef0123" integrationPackInstanceId="76543210FEDCBA9876543210FEDCBA98">
         </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:IntegrationPackEnvironmentAttachment" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg" 
           environmentId="456789ab-cdef-0123-4567-89abcdef0123" integrationPackInstanceId="76543210FEDCBA9876543210FEDCBA98"/>
      </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>IntegrationPackEnvironmentAttachment</objectType>
         <objectId>Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg</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