Environment object

The Environment object represents an environment.

For accounts with Unlimited environment support, you can classify environments as either Production or Test. For accounts with Basic environment support, the classification of all environments as Production.

Note: The fields in the Environment object correspond to controls in the Environments panel of the Runtime Management page.

Structure

<Environment classification="" name="" id=""/>

Field	Type	Description
classification	string	(Optional) For accounts with Unlimited environment support, the type of environment.The choices are PROD (Production) and TEST. The environment classification determines the type of license used when deploying a process to the environment. The default classification is PROD. You can assign the value TEST only if the requesting account has Test Connection Licensing enabled. You can set the classification only when you add an environment. You cannot change the classification later. Environments added prior to the January 2014 release have their classification set to PROD. Note: The classification field is invalid for requests from accounts with Basic environment support because all environments are production environments.
name	string	A user-defined name for the environment.
id	8	A unique ID assigned by the system to the environment.

Supported operations

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

Notes:

The ordinary GET operation retrieves the properties of the environment with a specified ID. The bulk GET operation retrieves the properties of the environments having the specified IDs, to a maximum of 100.
You can use the following fields as QUERY filters for the Environment object:

Field Allowed values
classification For accounts with Unlimited environment support PROD or TEST.
name Any string value.
id Any string value.

The operators allowed for the Environment 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 creates an environment having the specified name. Environment names must be unique.

You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot create environments.
The UPDATE operation updates the Environment object having the specified ID. You can edit the name field only.

You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update environments.
The DELETE operation deletes the Environment object with a specified ID.

You must have the Runtime Management privilege to perform the DELETE operation. If you have the Runtime Management Read Access privilege, you cannot delete environments.

It is not possible to delete an environment that has attached Runtimes or integration packs.

Field	Allowed values
classification	For accounts with Unlimited environment support PROD or TEST.
name	Any string value.
id	Any string value.

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>Environment</api:objectType>
         <api:objectId>456789ab-cdef-0123-4567-89abcdef0123</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:Environment" classification="PROD"  name="My Production Environment" 
             id="456789ab-cdef-0123-4567-89abcdef0123"/>
      </bns:getResponse>
   </S:Body>
</S:Envelope>

QUERY operation

The following example query returns all production environments.

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>Environment</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression operator="EQUALS" property="classification"
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                      <api:argument>PROD</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="4">
            <bns:result xsi:type="bns:Environment" classification="PROD" name="My Production Environment" 
                id="456789ab-cdef-0123-4567-89abcdef0123"/>
            ...
            <bns:result xsi:type="bns:Environment" classification="PROD" name="Deparment Environment" 
                id="56789abc-def0-1234-5678-9abcdef01234"/>
         </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:Environment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
						classification="PROD" name="My Production Environment">
         </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:Environment" name="My Production Environment" 
             classification="PROD" id="456789ab-cdef-0123-4567-89abcdef0123"/>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

UPDATE operation

This example updates the environment name to Our Production Environment.

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:update>
          <object xsi:type="api:Environment" id="456789ab-cdef-0123-4567-89abcdef0123" 
              classification="PROD" name="Our Production Environment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> 
          </object>
      </api:update>
   </soapenv:Body>
</soapenv:Envelope> 

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <bns:result xsi:type="bns:Environment" classification="PROD" name="Our Production Environment" 
            id="456789ab-cdef-0123-4567-89abcdef0123"/>
      </bns:updateResponse>
   </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>Environment</objectType>
         <objectId>456789ab-cdef-0123-4567-89abcdef0123</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