Cancels a running or queued pipeline job execution.
Request
Path parameters
| Key | Required | Type | Value | Description |
|---|---|---|---|---|
| jobId | Yes | string | objectId |
The unique identifier of the pipeline job to cancel. Example:
db93fdcb-00af-4187-80b8-58010f3d16f4 |
Request body
The request body contains the pipeline cancellation request.
| Key | Required | Type | Value | Description |
|---|---|---|---|---|
| status | Yes | string | "CANCELLED" |
The cancellation request |
{
"status": "CANCELLED"
}Response
The successful response stops the pipeline job and returns the 200 status message.
Response body
Example status code responses for this method are shown here. To view the response schemas, you can download the Data Quality Open API Specification from the Precisely Developer Portal.
Pipeline job cancelled successfully.
{
"jobId": "db93fdcb-00af-4187-80b8-58010f3d16f4",
"status": "CANCELLED",
"message": "Pipeline job has been successfully cancelled"
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "Invalid job id",
"instance": "/v1/quality/pipelines/jobs/db93fdcb-00af-4187-80b8-58010f3d16f4",
"errorCode": "DIS-QUALITY-PIPELINES-USR-0005"
}Pipeline job not found.
{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "Pipeline job not found",
"instance": "/v1/quality/pipelines/jobs/db93fdcb-00af-4187-80b8-58010f3d16f4",
"errorCode": "DIS-QUALITY-PIPELINES-USR-1003"
}{
"type": "about:blank",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred on the server",
"instance": "/v1/quality/pipelines/jobs/db93fdcb-00af-4187-80b8-58010f3d16f4",
"errorCode": "DIS-QUALITY-PIPELINES-SVC-0001"
}