Data Processing Engine Actions

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 variables of a Data Processing Engine definition. The input variables of each Data Processing Engine definition are unique. The Data Processing Engine action uses the input variables to execute the Data Processing Engine definition and generate a batch job ID.

Outputs

Usage

JSON Sample Request to execute PointsAccrual DPE Definition

{
   "PointsAccrual" : {
      "memberTier" : "Gold",
      "minimumPointBalanceRequired" : "50000",
      "pointType" : "non-qualifying"
   }
}

JSON Sample Response

{
   "actionName":"PointsAccrual",
      "errors":null,
      "isSuccess":true,
      "outputValues":{ 
        "batchJobId":"0lMxx0000A000001EAA"
      }
}

Example

GET

This example shows how to retrieve input variables of a Data Processing Engine action type.

curl --include --request GET \
--header "Authorization: Authorization: Bearer 00DR...xyz" \
--header "Content-Type: application/json" \
"https://instance.salesforce.com/services/data/v60.0/actions/custom/dataProcessingEngineAction/newinputvardefn"

POST

Here’s a request to retrieve DPE definition

{
  "inputs": [
    {
      "start_date": "26-09-2023",
      "end_date": "12-12-2023",
      "randomkey": "069SM0000001SgbYAE"
    }
  ]
}

Here’s a response for this action.

[
  {
    "actionName": "newinputvardefn",
    "errors": null,
    "invocationID": null,
    "isSuccess": true,
    "outputValues": {
      "batchJobId": "0mdSM0000006EJdYAM",
      "accepted": true
    },
    "version": 1
  }
]