Waiting for engine...
Skip to main content

Atom object

The Atom object represents a runtime, Runtime cluster, or Runtime cloud (runtime cloud clusters and Cloud Attachment).

note

Many of the fields in the Atom object correspond to controls in the Atom Information panel of the Runtime Management page.

Structure​

<Atom instanceId="" cloudId="" forceRestartTime="" purgeImmediate="" purgeHistoryDays="" 
   currentVersion="" dateInstalled="" hostName="" type="" status="" statusDetail="" name="" id="" createdBy="" cloudName="" cloudOwnerName="" cloudMoleculeName="" cloudMoleculeId="" isCloudAttachment=""/>
FieldTypeDescription
instanceIdstring(For Runtimes attached to Runtime clouds) A unique ID for the Runtime. The ID consists of the owning account ID followed by a period and a suffix.
cloudIdstring(For Runtimes attached to AtomClouds) A unique ID assigned by the system to the Runtime cloud.
createdBystringThe user ID (email address) of a user who created the Runtime.
forceRestartTimelongThe length of time, in milliseconds, that the platform waits before it forces the Atom (or Runtime cluster or Runtime cloud) to restart after changes to the Atom’s configuration. Changes do not take effect until a restart occurs. However, regardless of this value, in a Runtime cluster or Runtime cloud that uses forked execution, automatic restart is deferred until currently running processes are complete.
purgeImmediatebooleanIf true, purges processed documents and temporary data immediately after a process ends. If you set this to true, also set purgeHistoryDays to a value greater than 0, such as 1. This combination not only purges your data right away, but also runs an extra cleanup process on a daily basis.
purgeHistoryDaysintThe number of days after a process run when the purging of logs, processed documents, and temporary data occurs. The default is 30 days. The maximum is 9999. A value of 0 disables purging.
currentVersionstringA string that identifies the runtime, Runtime cluster, or Runtime cloud's latest build.
dateInstalleddateTime yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2016-02-05T15:32:00Z\The installation date and time of the runtime, Runtime cluster, or Runtime cloud. For Runtimes attached to a Runtime cloud, this is the installation date and time of the Runtime cloud.
hostNamestringThe name or IP address of the installation machine for the runtime, Runtime cluster, or Runtime cloud. If the Atom is attached to a Runtime cloud, the name of the Runtime cloud appears.
typeAtomTypeThe type of Runtime. Possible values are: Cloud, Molecule, Atom
statusAtomStatusThe status of the Runtime. Possible values are: UNKNOWN, ONLINE, WARNING, OFFLINE
namestringA user-defined name for the runtime, Runtime cluster, or Runtime cloud.
idstringA unique ID for the runtime, Runtime cluster, or Runtime cloud.
cloudNamestringThe name of the associated Runtime cloud. This field is populated only for Cloud Attachments and runtime cloud clusters.
cloudOwnerNamestringThe account name of the associated Runtime cloud’s owner.
cloudMoleculeNamestringThe name of the runtime cloud clusters to which the Cloud Attachment is assigned. This field is populated only for Cloud Attachments.
cloudMoleculeIdstringID of the runtime cloud clusters to which the Cloud Attachment is assigned. This field is populated only for Cloud Attachments.
isCloudAttachmentBooleanIndicates if a Runtime is a Cloud Attachment. It is set to True for the Cloud Attachment; otherwise, it is False for other Runtime. It is only populated for Cloud Attachments and runtime cloud clusters.
statusDetailstringProvides more granular status details for the runtime.
Possible values are:
When the runtime status is ONLINE:
  • ONLINE_RUNNING
  • ONLINE_STOPPING
  • ONLINE_STARTING
  • CLUSTER_ISSUE
  • RESTARTING
  • RESTARTING_TOO_LONG
  • RESTARTING_DEAD
When the runtime status is OFFLINE:
  • OFFLINE
  • OFFLINE_NOT_STOPPED
  • OFFLINE_NOT_INITIALIZED
  • OFFLINE_WITH_ERROR
  • OFFLINE_WITH_CLUSTER_ISSUE
  • DELETED
  • OFFBOARDING
When the runtime status is WARNING:
  • CLUSTER_ISSUE
When the runtime status is UNKNOWN:
  • UNKNOWN
note

As of April 13, 2024, the createdBy field returns in the successful responses of the CREATE, GET, and QUERY operations. It will not be returned for the Runtimes that were created prior to this date.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedNot supportedSupported

Using the CREATE operation​

  • The CREATE operation conceptually creates and attaches a Runtime with the specified name to a specified Runtime cloud owned by the requesting account. This operation cannot be used to create a local Runtime.

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

    note

    The createdBy is a system-generated or read-only field. It cannot be passed in a CREATE request.

Using the GET operation​

  • The ordinary GET operation retrieves the properties of the runtime, Runtime cluster, or Runtime cloud having the specified ID. The bulk GET operation retrieves the properties of the Runtimes, Runtime clusters, and Runtime clouds having the specified IDs, to a maximum of 100.

    For Runtime clusters and Runtime clouds that are part of a multi-node runtime, the GET operation returns values for the following additional variables:

    • nodeId
    • hostName
    • status
    • clusterProblem

    For more information on these variables, refer to the topic Cluster Status panel.

Using the UPDATE operation​

  • The UPDATE operation updates the Atom object having the specified ID. You can update these fields only:

    • name
    • purgeHistoryDays
    • purgeImmediate
    • forceRestartTime

    You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update a Runtime.

    note

    There might be a delay before you see the changes in the Atom Information panel.

Using the DELETE operation​

  • The DELETE operation deletes the Atom object with the 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 a Runtime.

Using the QUERY operation​

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

    FieldAllowed values
    hostnameAny string value. Attention: Due to a known issue, you must use the hostname as the filter to query a host name. Using camel case results in an error.
    typeAtom, Cloud or Molecule.
    statusUNKNOWN, ONLINE, WARNING or OFFLINE.
    nameAny string value.
    idAny string value.
    capabilitiesBROKER or GATEWAY

    The operators allowed for the Atom object filters are:

    • BETWEEN
    • CONTAINS
    • EQUALS
    • GREATER_THAN
    • GREATER_THAN_OR_EQUAL
    • IS_NULL
    • IS_NOT_NULL
    • LESS_THAN
    • LESS_THAN_OR_EQUAL
    • LIKE
    • NOT_CONTAINS
    • NOT_EQUALS

    However, you can use the EQUALS and NOT_EQUALS operators only with the type filter parameter.

    Use either BROKER or GATEWAY with either the CONTAINS or NOT_CONTAINS operator to filter by API Gateways and Authentication Brokers that you own.

    For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

    note

    SOAP and REST APIs ignore the capabilities property for Update and Create operations.

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>Atom</api:objectType>
             <api:objectId>3456789a-bcde-f012-3456-789abcdef012</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:Atom" forceRestartTime="9" purgeImmediate="false" 
                 purgeHistoryDays="18" currentVersion="17.08.0.0" dateInstalled="2016-02-05T14:49:21Z" 
                 hostName="WN7X64-11A2BB3" type="ATOM" status="OFFLINE" name="My Local Atom" 
                 id="3456789a-bcde-f012-3456-789abcdef012"/>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

    For Runtime clusters and Runtime clouds that are part of a multi-node runtime, the following example returns node status variables.

    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>
                <!--Optional:-->
                <api:objectType>Atom</api:objectType>
                <!--Optional:-->
                <api:objectId>3456789a-bcde-f012-3456-789abcdef012</api:objectId>
            </api:get>
        </soapenv:Body>
    </soapenv:Envelope>

    Response:


    <S:Envelope
        xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
        <S:Body>
            <bns:getResponse
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:bns="http://api.platform.boomi.com/">
                <bns:result xsi:type="bns:Atom" id="3456789a-bcde-f012-3456-789abcdef012" name="My Local Cloud" status="ONLINE" type="CLOUD" hostName="WN7X64-11A2BB3" dateInstalled="2014-06-23T15:19:55Z" currentVersion="22.05.0-20220413.164814-12" purgeHistoryDays="14" purgeImmediate="false" forceRestartTime="180000" cloudId="d9ab3399-4345-463e-8710-8484adba0295">
                    <bns:cluster>
                        <bns:node>
                            <bns:nodeId>172_16_21_144</bns:nodeId>
                            <bns:hostName>atom01.boomi.com</bns:hostName>
                            <bns:status>RUNNING</bns:status>
                        </bns:node>
                        <bns:node>
                        <bns:nodeId>172_16_22_55</bns:nodeId>
                        <bns:hostName>atom02.boomi.com</bns:hostName>
                        <bns:status>RUNNING</bns:status>
                        </bns:node>
                        <bns:node>
                            <bns:nodeId>172_16_21_36</bns:nodeId>
                            <bns:hostName>atom03.boomi.com</bns:hostName>
                            <bns:status>RUNNING</bns:status>
                        </bns:node>
                        <bns:node>
                            <bns:nodeId>172_16_22_223</bns:nodeId>
                            <bns:hostName>atom04.boomi.com</bns:hostName>
                            <bns:status>RUNNING</bns:status>
                        </bns:node>
                        <bns:node>
                            <bns:nodeId>172_16_21_37</bns:nodeId>
                            <bns:hostName>atom05.boomi.com</bns:hostName>
                            <bns:status>RUNNING</bns:status>
                        </bns:node>
                        <bns:node>
                            <bns:nodeId>172_16_22_224</bns:nodeId>
                            <bns:hostName>atom06.boomi.com</bns:hostName>
                            <bns:status>RUNNING</bns:status>
                        </bns:node>
                    </bns:cluster>
                </bns:result>
            </bns:getResponse>
        </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns all online Atoms.

    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>Atom</api:objectType>
             <api:queryConfig>
                 <api:QueryFilter>
                    <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression"> 
                        <api:nestedExpression operator="EQUALS" property="status" xsi:type="api:SimpleExpression">
                           <api:argument>ONLINE</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="type" xsi:type="api:SimpleExpression">
                           <api:argument>ATOM</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="6">
                <bns:result xsi:type="bns:Atom" forceRestartTime="9" purgeImmediate="false" 
                    purgeHistoryDays="18" currentVersion="17.08.0.0" dateInstalled="2016-02-05T14:49:21Z" 
                    hostName="WN7X64-11A2BB3" type="ATOM" status="ONLINE" name="My Local Atom" 
                    id="3456789a-bcde-f012-3456-789abcdef012"/>
                ...
                <bns:result xsi:type="bns:Atom" forceRestartTime="9" purgeImmediate="false"  
                    purgeHistoryDays="15" currentVersion="17.08.0.0" dateInstalled="2016-01-09T11:22:33Z"
                    hostName="WN7X64-11A2BB3" type="ATOM" status="ONLINE" name="My Sixth Local Atom" 
                    id="210fedcb-a987-6543-210f-edcba9876543"/>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    This example creates and attaches a Runtime named Cloud Atom to the Runtime cloud whose ID is 23456789-abcd-ef01-2345-6789abcdef01 owned by 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:create>
              <object xsi:type="api:Atom" cloudId="23456789-abcd-ef01-2345-6789abcdef01" 
                  name="Cloud Atom" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> 
          </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:Atom" instanceId="account-123456.HP81GZ" cloudId="23456789-abcd-ef01-2345-6789abcdef01" 
                 forceRestartTime="0" purgeImmediate="false" purgeHistoryDays="30" dateInstalled="2016-06-10T16:11:26.749Z"
                 hostName="Cloud-WN7X64-9L7K7S2.domain.tld" type="CLOUD"
                 status="ONLINE" name="Cloud Atom" id="df2d9aa6-0f66-546a-9e3c-0a9a3531ec26"/>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    This example updates purgeHistoryDays, which sets the number of days to 90 following a process run that purges logs, processed documents, and temporary data.

    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:Atom" id="3456789a-bcde-f012-3456-789abcdef012" 
                  purgeHistoryDays="90" 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:Atom" id="3456789a-bcde-f012-3456-789abcdef012" purgeHistoryDays="90"/>
          </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>Atom</objectType>
             <objectId>3456789a-bcde-f012-3456-789abcdef012</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>

On this Page