Run an Executable — Batch

POST{orgBaseUrl}/services/apexrest/pushtopics/execution/batch/executable/{executableApiName}

Path Parameters

Parameter Type Required Description
executableApiNamestringYesAPI name of the Executable to run.

Request Body

Parameter Type Required Description
sourceRecordIdsarray of stringsNoIDs of records from the Executable's source object. Omit this parameter to let the Executable retrieve records using its configured criteria.

Request Example

Run the Executable for specific source records:

json
{
  "sourceRecordIds": [
    "001XXXXXXXXXXXX"
  ]
}

Returns

Returns the ID of the submitted Execution record. The returned ID confirms that the execution was submitted. It does not indicate that processing has finished.