RuntimeProperties object

The RuntimeProperties object lets you manage and configure runtime and system properties across runtimes (basic runtime, runtime cloud, and local cluster) programmatically.

Required privileges: You must have Runtime Management or Runtime Management Read Access privilege to use the RuntimeProperties API.

Field	Type	Description
standardProperties	object	Runtime-specific settings. For more information about Standard Properties, refer to Basic and Advanced Properties
systemProperties	object	System properties are settings that apply to the Java Virtual Machine (JVM) and its configuration.
partialUpdate	boolean	Supplied only in an UPDATE operation. Determines how existing container properties get updated. By default, it is set to false. If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged. If set to false, property values specified in the request get updated. However, other Basic and Advanced property values not included in the request are reset to their default values.
runtimeId	string	Read-only. System-generated unique identifier of the runtime.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE

Using the GET operation

Retrieves the details of Basic and Advanced properties of the runtime. Retrieving runtime and system properties is an asynchronous process:

1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform. https://api.boomi.com/api/soap/v1/<accountId>/async/RuntimeProperties/<runtimeId>
   The accountId is the ID of the authenticating account for the request, and runtimeId is the ID of the runtime.
2. The platform returns a token.
3. Send one or more GET requests that include the token. https://api.boomi.com/api/soap/v1/<accountId>/async/RuntimeProperties/response/<token>
4. The platform returns a list of the properties associated with the specific runtime.

note

The runtime that you are calling must be online.

Initial GET response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncGetResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:result responseStatusCode="202">
                <bns:asyncToken token="RuntimeProperties-685ebf65-3b87-42fa-ba0d-7200e2ece06e"/>
            </bns:result>
        </bns:asyncGetResponse>
    </S:Body>
</S:Envelope>

Subsequent GET response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:asyncResultResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
            <bns:results responseStatusCode="200">
                <bns:result xsi:type="bns:RuntimeProperties" runtimeId="73485da4-79f6-4805-9159-91b2bf7555ab">
                    <bns:standardProperties containerName="Test01_Cloud" 
                        containerHostName="Test01_Cloud" 
                        containerPurgeImmediately="false" 
                        containerPurgeDays="30" containerForceRestart="0" useLocalStorageForRuntimeAssets="false" maxForkedExecutionTimeInCloud="60000"/>
                    <bns:systemProperties heapSize="512m" tempDirectory="/var/folders/98/yr8w302j4n5_fcc_hq9hprsh0000gn/T" clientDefaultConnectTimeout="120000" 
                        clientDefaultReadTimeout="120000" javaClassPathPrepend="/Applications/Boomi_AtomSphere/Cloud/Cloud_QA_Test01_Cloud/jre/lib/tools.jar" 
                        javaSecurityCompatibility="JVM_DEFINED" jgroupsClusteredLibraryVersion="3" 
                        preferIpv4Stack="true" retryHttpPost="false"/>
                </bns:result>
            </bns:results>
        </bns:asyncResultResponse>
    </S:Body>
</S:Envelope>

Using the UPDATE operation

Adds, removes, or updates standard and system properties for runtimes through a single API call, supporting partial update. The update operation includes a partialUpdate flag, which can be set to either "true" or "false." This flag determines how existing container properties will be updated.

• If set to true, only the property values specified in the request get updated. All other existing properties within the container will remain unchanged.
• If set to false, property values specified in the request get updated. However, other Basic and Advanced property values not included in the request are reset to their default values.

Request:

<bns:RuntimeProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" runtimeId="1fb4f171-0486-4b66-9b3d-6c323a254adb" partialUpdate="true">
 <bns:standardProperties containerName="Basic_Atom" containerHostName="Basic_Atom" containerPurgeImmediately="false" containerPurgeDays="31" containerForceRestart="0" debugLogging="true" standardOutputAndErrorLogging="true" forceStartSharedWebServer="true"/>
 <bns:systemProperties heapSize="512m" clientDefaultConnectTimeout="120000" clientDefaultReadTimeout="120000" javaClassPathPrepend="/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar" javaSecurityCompatibility="JVM_DEFINED" jgroupsClusteredLibraryVersion="3" jmxRemoteAuthentication="false" jmxRemotePort="6005" jmxRemoteSsl="false" preferIpv4Stack="true" retryHttpPost="false"/>
</bns:RuntimeProperties>

Response:

<bns:RuntimeProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" runtimeId="1fb4f171-0486-4b66-9b3d-6c323a254adb" partialUpdate="true">
 <bns:standardProperties containerName="Basic_Atom" containerHostName="Basic_Atom" containerPurgeImmediately="false" containerPurgeDays="31" containerForceRestart="0" debugLogging="true" standardOutputAndErrorLogging="true" forceStartSharedWebServer="true"/>
 <bns:systemProperties heapSize="512m" clientDefaultConnectTimeout="120000" clientDefaultReadTimeout="120000" javaClassPathPrepend="/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar" javaSecurityCompatibility="JVM_DEFINED" jgroupsClusteredLibraryVersion="3" jmxRemoteAuthentication="false" jmxRemotePort="6005" jmxRemoteSsl="false" preferIpv4Stack="true" 
retryHttpPost="false"/>
</bns:RuntimeProperties>