Cancel a running rule job - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Cancels a running rule job based on the provided jobId. Returns the cancellation status and error details if any.

HTML

PUT https://hostname/v1/quality/rules/jobs/{jobId}

Request

Path parameters

Key Required Type Description
jobId Yes string

Job ID to cancel.

Response

The response returns the cancellation status and error details if any.

Response body properties

Property Required Type Description
executionId No string  
status No string  
error No string  

Response examples

Example status code responses for this method are shown here.

Examples

Successfully cancelled the running rule job.

{
   "taskId":"9cf1012e-157d-4819-b851-232c7000c3a3",
   "startDate":"2025-11-27T11:40:18.838Z",
   "endDate":"2025-11-27T11:40:27.177Z",
   "status":"CANCELLED",
   "comments": [
      Job Cancelled
   ]
}

Bad request, provided invalid jobId to cancel the running rule job.

{
"type":"about:blank",
"title":"Bad Request",
"status":"400",
"detail":"Invalid jobId",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/jobs/job-123",
"errorCode":"DIS-QUALITY-RULES-USR-0004"
}