Cloud object

The Cloud object represents a Runtime cloud that is available to the requesting account. You can retrieve a Runtime cloud's properties and query for Runtime clouds by name or ID.

Structure

<Cloud name="" id="">
   <Atom atomId=""/>
   .
   .
   .
   <Atom atomId=""/>
</Cloud>

Field	Type	Description
name	string	The name of the Runtime cloud.
id	string	A unique ID assigned by the system to the Runtime cloud.
atomId	string	A unique ID assigned by the system to a Runtime installed on the Runtime cloud.
deleted	string	Specifies the status of a Runtime. A true value indicates a Runtime is deleted, whereas a false value indicates a Runtime is active.

Supported operations

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

Notes:

• Returns the IDs of Runtimes attached to a Runtime cloud only if the requesting account is the Runtime cloud owner.

• The ordinary GET operation retrieves the properties of the Runtime cloud having the specified ID. The bulk GET operation retrieves the properties of the Runtime clouds having the specified IDs, to a maximum of 100. For more information, see the bulk GET operations topic.

• You can use the following fields as QUERY filters for the Cloud object:

  Field	Allowed values
  id	Any string value.
  name	Any string value.

  The operators allowed for Cloud object filters are:

  • BETWEEN
  • EQUALS
  • GREATER_THAN
  • IS_NOT_NULL
  • GREATER_THAN_OR_EQUAL
  • 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.

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>Cloud</api:objectType>
           <api:objectId>23456789-abcd-ef01-2345-6789abcdef01</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:Cloud" name="MyCompany Cloud" id="23456789-abcd-ef01-2345-6789abcdef01">
              <bns:Atom atomId="3456789a-bcde-f0123-4567-89abcdef012"/>
              ...
              <bns:Atom atomId="cdef0123-4567-89ab-cdef-0123456789ab"/>
           </bns:result>
        </bns:getResponse>
     </S:Body>
  </S:Envelope>

• QUERY operation

  The following example query returns Runtime clouds named MyCompany Cloud that are 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>Cloud</api:objectType>
           <api:queryConfig>
               <api:QueryFilter>
                  <api:expression operator="EQUALS" property="name"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>MyCompany Cloud</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="1">
              <bns:result xsi:type="bns:Cloud" name="MyCompany Cloud" id="23456789-abcd-ef01-2345-6789abcdef01">
                 <bns:Atom atomId="3456789a-bcde-f0123-4567-89abcdef012"/>
                 ...
                 <bns:Atom atomId="cdef0123-4567-89ab-cdef-0123456789ab"/>
              </bns:result>
           </bns:results>
       </bns:queryResponse>
     </S:Body>
  </S:Envelope>