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.

Special Access Rules

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.

Supported REST HTTP Methods

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.

Inputs

Input	Type	Description
`executionReferenceId`	ID	Required. The ID of a record aggregation definition or a Data Processing Engine definition to run to refresh data aggregation.

Outputs

Output	Type	Description
`accepted`	boolean	Indicates whether the specified Data Processing Engine definition was accepted for processing (`true`) or not (`false`).
`batchJobId`	string	The ID of the batch job that was created.

Example

GET

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

1curl --include --request GET \
2--header "Authorization: Authorization: Bearer 00DR...xyz" \
3--header "Content-Type: application/json" \
4"https://instance.salesforce.com/services/data/v59.0/actions/standard/runRecordAggrBatchProcDef"

POST

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

1{
2   "inputs":[
3      {
4         "executionReferenceId": "16ySB000000003FYAQ"
5      }
6   ]
7}

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

1[
2  {
3    "actionName": "runRecordAggrBatchProcDef",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "batchJobId": "0mdSB0000000dSnYAI",
8      "accepted": true
9    },
10    "version": 1
11  }
12]