Start a pipeline - 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 and starts a new data quality pipeline job with the specified pipeline and run configuration.

HTTP

POST https://hostname/v1/quality/pipelines/jobs

Request

Request body

The request body encapsulates an object for creating a new pipeline job.

object Type Details
pipelineId string

Unique identifier of pipeline to be run.

Example: 67e259257f3a733215481765
runConfigId string

Unique identifier of the run configuration to use for the pipeline job.

Example: 689db618617b4bd63438e56d
{
  "pipelineId": "67e259257f3a733215481765",
  "runConfigId": "689db618617b4bd63438e56d"
}

Response

The successful response returns the job ID of the pipeline job.

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.

Examples
Pipeline job created successfully.
{
  "jobId": "db93fdcb-00af-4187-80b8-58010f3d16f4"
}
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "instance": "/v1/quality/pipelines/jobs",
  "errors": {
    "pipelineId": [
      "DIS-QUALITY-PIPELINES-USR-0003:Invalid pipeline id"
    ]
  }
}
{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred on the server",
  "instance": "/v1/quality/pipelines/jobs",
  "errorCode": "DIS-QUALITY-PIPELINES-SVC-0001"
}