Run Record Aggregation Batch Processing Definition Action

Runs a Data Processing Engine definition to process an asynchronous batch job that creates or updates record aggregation results.

This action is available in API version 59.0 and later.

To access the Run Record Aggregation Batch Processing Definition action, you must have the Record Aggregation permission set license, and you must have the Record Aggregation Access permission.

URI: /services/data/vXX.X/actions/standard/runRecordAggrBatchProcDef

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: GET, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

InputTypeDescription
executionReferenceIdIDRequired.
The ID of a record aggregation definition or a Data Processing Engine definition to run to refresh data aggregation.
OutputTypeDescription
acceptedbooleanIndicates whether the specified Data Processing Engine definition was accepted for processing (true) or not (false).
batchJobIdstringThe ID of the batch job that was created.

GET

This example shows how to get the details of the Run Record Aggregation Batch Processing Definition action type.

POST

Here’s a request for the Run Record Aggregation Batch Processing Definition action.

Here’s a response for the Run Record Aggregation Batch Processing Definition action.