Component Environment Attachment object (Legacy deployment, Deprecated)

The Component Environment Attachment object enables the attachment or detachment of a component to or from a particular environment.

caution

The Component Environment Attachment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Deployed Package object instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about 's API object deprecation status, refer to the topic API deprecation and versioning policy.

Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new Deployment workflow and How to upgrade Legacy accounts to use the new deployment workflow. In the meantime, do not use the replacement API without first converting your Legacy account.

Structure

<ComponentEnvironmentAttachment environmentId="" componentId="" componentType="" id=""/>

Field	Type	Description
Filter	Filter	Filter
environmentId	string	The ID of the environment.
componentId	string	The ID of the component.
componentType	string	The type of component: certificate, customlibrary, process, processroute, tpgroup, or webservice.
id	string	The object’s conceptual ID, which is synthesized from the environment and component IDs.

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 Component Environment Attachment object:

Field	Allowed values
environmentId	Any string value (valid environment ID).
componentId	Any string value (valid component ID).
componentType	certificate, customlibrary, process, processroute, tpgroup, or webservice

The operators allowed for the Component 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 a component with a specific ID to the environment with a specific ID.
The DELETE operation detaches a component from an environment where the attachment is specified by the conceptual Component Environment Attachment object ID. This ID is returned by the CREATE operation that originated the attachment and can also be obtained from a QUERY operation.

You must have the Runtime Management privilege to perform the CREATE or DELETE operations. If you have the Runtime Management Read Access privilege, you cannot create or delete component attachments.

SOAP implementation

QUERY operation

The following example query returns the processes attached to the environment whose ID is cd996e7e-71a6-4a95-8e47-80d44ae6f2d9.

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>ComponentEnvironmentAttachment</api:objectType>
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="and" xsi:type="api:GroupingExpression" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                  <api:nestedExpression operator="EQUALS" property="environmentId" xsi:type="api:SimpleExpression">
                     <api:argument>cd996e7e-71a6-4a95-8e47-80d44ae6f2d9</api:argument>
                  </api:nestedExpression>
                  <api:nestedExpression operator="EQUALS" property="componentType" xsi:type="api:SimpleExpression">
                     <api:argument>process</api:argument>
                  </api:nestedExpression>
               </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:ComponentEnvironmentAttachment" componentType="process" environmentId="cd996e7e-71a6-4a95-8e47-80d44ae6f2d9" componentId="aa270ba9-b0ba-4b59-bf59-c92ff2d6ccb9" id="QVRUQUNIX0NPTVBPTkVOVF9FTlZhYTI3MGJhOS1iMGJhLTRiNTktYmY1OS1jOTJmZjJkNmNjYjk6Y2Q5OTZlN2UtNzFhNi00YTk1LThlNDctODBkNDRhZTZmMmQ5"/>
            <bns:result xsi:type="bns:ComponentEnvironmentAttachment" componentType="process" environmentId="cd996e7e-71a6-4a95-8e47-80d44ae6f2d9" componentId="3e5e2e2f-26dd-4118-b6d5-ed63a04c073e" id="QVRUQUNIX0NPTVBPTkVOVF9FTlYzZTVlMmUyZi0yNmRkLTQxMTgtYjZkNS1lZDYzYTA0YzA3M2U6Y2Q5OTZlN2UtNzFhNi00YTk1LThlNDctODBkNDRhZTZmMmQ5"/>
         </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>
         <!--Optional:-->
         <object xsi:type="api:ComponentEnvironmentAttachment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" environmentId="3da3d1a9-1ce1-463e-9d60-42af92b11b2d" componentId="aa270ba9-b0ba-4b59-bf59-c92ff2d6ccb9">
        </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">
         <result xsi:type="bns:ComponentEnvironmentAttachment" componentType="process" environmentId="3537214d-aeb0-4bf1-a1c1-6c835461f800" componentId="aa270ba9-b0ba-4b59-bf59-c92ff2d6ccb9" id="QVRUQUNIX0NPTVBPTkVOVF9FTlZhYTI3MGJhOS1iMGJhLTRiNTktYmY1OS1jOTJmZjJkNmNjYjk6MzUzNzIxNGQtYWViMC00YmYxLWExYzEtNmM4MzU0NjFmODAw"/>
      </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>ComponentEnvironmentAttachment</objectType>
         <objectId>QVRUQUNIX0NPTVBPTkVOVF9FTlY2NmJjYjU3ZS1hMGU3LTQyOTMtOTM2Mi04MWY0YmNjMGIxNmU6NjExZWZhOTEtYmVjMC00YmY2LWIwMDUtZjMzMTk3OWJlZGU2</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">
         <successful>true</successful>
      </bns:deleteResponse>
   </S:Body>
</S:Envelope> 

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation