Newer Version Available

This content describes an older version of this product. View Latest

Data Processing Engine Actions

Run an active Data Processing Engine definition. This action executes a Data Processing Engine definition asynchronously.

A Data Processing Engine definition transforms data from your Salesforce org and writes back the results to your org. For more information about running Data Processing Engine definitions, see Run a Data Processing Engine Definition in Salesforce Help.

This object is available in API version 51.0 and later.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/custom/dataProcessingEngineAction
Formats
JSON
HTTP Methods
GET, POST
Authentication
Authorization: Bearer token

Inputs

Use the GET method to retrieve input parameters of a Data Processing Engine definition. The Data Processing Engine action uses input variables to execute the data processing engine definition and generate a batch job ID. The input values vary according to the input fields in the Data Processing Engine definition.

Outputs

Output Details
batchJobId
Type
string
Description
ID of the batch job generated after the request is successful. This ID is used to track the progress of the batch job in Monitor Workflow Services.

Usage

JSON Sample Request

1{
2   "PointsAccrual" : {
3      "memberTier" : "Gold",
4      "minimumPointBalanceRequired" : "50000",
5      "pointType" : "non-qualifying"
6   }
7}

JSON Sample Response

1{
2   "actionName":"PointsAccrual",
3      "errors":null,
4      "isSuccess":true,
5      "outputValues":{ 
6        "batchJobId":"0lMxx0000A000001EAA"
7      }
8}