Available in version v4+
The object containing a related data record and a filter describing which records to select. Used to update rows in a related data set. If filter attributes are provided, only records with matching values for all columns and value pairs are selected.
Name | Type | Description | Constraints |
|---|
datasetName | String | Name of the related data set in which records will be updated. All related data records reside within a data set identified by a unique name. | required |
key | String | Key defining which record(s) to select from the related data set. | required |
data | Attribute | A list of Attribute objects describing data values to be written to one or more related data records. Each Attribute object represents a column name and the desired value to be written into that column. Only the subset of columns to be updated needs to be provided. Columns for provided column names not exiting in the dataset will not be created on the fly. | required |
filter | Attribute | An optional list of Attribute objects used for filtering which related data records to select. Each Attribute object represents a column name and the desired value the records need to have in that column in order to be selected. All other records are filtered from the result set. Providing a filter is used to prevent an operation to be carried out on all records with the same key in a dataset defined with non-unique keys, e.g. when updating a specific order when order history is stored with an email address as keys. | optional |
Available in version v7+
An object that contains the ID of the process initiated by the request and the processing type. The result of time-based automation that was executed using the runOnce request. When there is no value for the processID property, there were no system processes involved in the execution.
Name | Type | Description | Constraints |
|---|
processId | Long | The ID of the process initiated by the request. | optional |
processingType | ProcessingType | The type of processing used to execute the process. | required |
