Persisted Process Properties object
The Persisted Process Properties object represents the collection of properties that a Runtime persists across subsequent runs.
The owner of a Runtime cloud or Runtime cluster can retrieve a list of all Persisted Process properties for a specified container. You can also update a property by adding, changing, or removing a container's Persisted Process properties.
Retrieving a list of Persisted Process properties is an asynchronous process:
- The client sends a GET request that specifies a list of all a container's Persisted Process properties to the Boomi Enterprise Platform.
- The platform returns a persisted process property token for the specified runtime, Runtime cluster, or Runtime cloud.
- The client sends one or more GET requests that include the Persisted Process properties token.
- The platform returns one of the following: Status code 202 while the request is in progress.
- Status code 200 with the custom contents of the security policy when the request is complete.
Structure
<AsyncOperationResult responseStatusCode="">
<result type="PersistedProcessProperties">
<PersistedProcessProperties>
<atomId></atomId>
<processes>
<processId></processId>
<PersistedProcessProperties>
<ProcessProperty>
<name>processname1</name>
<value>value1</value>
</ProcessProperty>
<ProcessProperty>
<name>processname2</name>
<value>value2</value>
</ProcessProperty>
</PersistedProcessProperties>
</processes>
</PersistedProcessProperties>
</result>
</AsyncOperationResult>
| Field | Type | Description |
|---|---|---|
| PersistedProcessProperties | string | The complete list of Persisted Process properties within the specified Runtime, Runtime cluster, or Cloud, where the definition of each property is by its name and value. |
| atomId | string | A unique ID assigned by the system to the Runtime. |
| ProcessId | string | A unique ID assigned by the system to the process. |
| name | string | The name of the persisted process property. |
| value | string | The value assigned to the persisted process property. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Supported | Not Supported | Not Supported | Supported | Not Supported | Not Supported |
Notes:
-
The UPDATE operation updates Persisted Process Property values for the specified Runtime. Using the UPDATE operation overrides all current property settings. Therefore, Boomi recommends that you include a complete list of all Persisted Process properties you want to keep or update. If you do not list a current persisted process property in the Persisted Process properties object, the UPDATE operation deletes those properties.
-
The GET operation returns the current state of the Persisted Process properties names and values for the specified Runtime.
The initial GET operation returns a token for the specified Runtime.