Environment Atom Attachment object

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

Structure

<EnvironmentAtomAttachment atomId="" environmentId="" id=""/>

Field	Type	Description
atomId	string	The ID of the Runtime.
environmentId	string	The ID of the environment.
id	string	The object’s conceptual ID, which is synthesized from the Atom and environment IDs.

Supported operations

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

Notes:

The following fields can be used as QUERY filters for the Environment Atom Attachment object:

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

The operators allowed for the Environment Atom 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 Runtime having the specified ID to the environment having the specified ID. Attaching an already attached Atom moves the Atom to the environment specified in the request.

You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot attach Atoms.

Note: For accounts with Basic environment support, you can attach a single Atom to each environment. For accounts with Unlimited environment support, you can attach have an unlimited number of Runtimes attached in each environment.
The DELETE operation detaches a Runtime from an environment where the attachment is specified by the conceptual Environment Atom 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 DELETE operation. If you have the Runtime Management Read Access privilege, you cannot delete Atom attachments.

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

SOAP implementation

QUERY operation

The following example query returns the Runtimes 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>EnvironmentAtomAttachment</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:EnvironmentAtomAttachment" atomId="3456789a-bcde-f012-3456-789abcdef012" 
                environmentId="456789ab-cdef-0123-4567-89abcdef0123" 
                id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"/>
            <bns:result xsi:type="bns:EnvironmentAtomAttachment" atomId="fedcba98-7654-3210-fedc-ba9876543210" 
                environmentId="456789ab-cdef-0123-4567-89abcdef0123" 
                id="b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA"/>
         </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:EnvironmentAtomAttachment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
             atomId="3456789a-bcde-f012-3456-789abcdef012" environmentId="456789ab-cdef-0123-4567-89abcdef0123">
         </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:EnvironmentAtomAttachment" atomId="3456789a-bcde-f012-3456-789abcdef012" 
             environmentId="456789ab-cdef-0123-4567-89abcdef0123" 
             id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"/>
      </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>EnvironmentAtomAttachment</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