Create a job for a rule - 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

Creates a job for the specified rule ID. The asset ID is optional. Returns a job response with a unique job identifier.

HTML

POST https://hostname/v1/quality/rules/{ruleId}/jobs

Request

Path parameters

Key Required Type Description
ruleId Yes string

ID of the rule on which job need to be trigger.

Request body properties

Property Required Type Description
assetId No string Asset ID for the job request.
name No string

Name for the job request. Should be a human-readable identifier for the job, such as 'Customer Data Quality Job' or 'Sales Metrics Analysis'

Response

The successful response returns a unique job identifier for the new job.

Response body properties

Property Required Type Description
jobId No string Unique identifier for the job.

Response examples

Example status code responses for this method are shown here.

Examples

Job created successfully.

{
   "jobId":"123e4567-e89b-12d3-a456-426614174000"
}
{
   "type":"about:blank",
   "title":"Bad Request",
   "status":"400",
   "detail":"Invalid job request",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/jobs",
   "errorCode":"DIS-QUALITY-JOB-USR-0001"
}
{
   "type":"about:blank",
   "title":"Not Found",
   "status":"404",
   "detail":"Rule not found for given ID",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/jobs",
   "errorCode":"DIS-QUALITY-JOB-USR-0002"
}
{
   "type":"about:blank",
   "title":"Internal Server Error",
   "status":"500",
   "detail":"An unexpected error occurred on the server",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/jobs",
   "errorCode":"DIS-QUALITY-JOB-SVC-0001"
}