Run a Pipeline — Batch
POST
{orgBaseUrl}/services/apexrest/pushtopics/execution/batch/pipeline/{pipelineApiName}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| pipelineApiName | string | Yes | API name of the Pipeline to run. |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| additionalRetrieveParameters | string | No | An additional condition used to filter the records retrieved by the Pipeline. Omit it when no additional filter is needed. |
| chainNextPipeline | boolean | No | Controls whether the Pipeline's configured Next Pipeline runs after the current Pipeline completes. Defaults to false. |
Request Example
Filter the retrieved records and run the configured Pipeline chain:
json
{
"additionalRetrieveParameters": "CreatedDate = TODAY",
"chainNextPipeline": true
}Returns
Returns the ID of the submitted Pipeline Execution record. The returned ID confirms that the execution was submitted. It does not indicate that processing has finished.