List available run configurations for 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

Retrieves a paginated list of run configurations associated with a specific pipeline ID.

HTTP

GET https://hostname/v1/quality/pipelines/{pipelineId}/run-configs

Request

Path parameters

Key Required Type Value Description
pipelineId Yes string objectId

Unique identifier of the pipeline for which to retrieve run configurations.

Example: 67e259257f3a733215481765

Query parameters

Key Required Type Value Description
page No integer integer($int32)

Page number.

  • Minimum: 1
  • Default: 1
limit No integer integer($int32)

Number of items per page.

  • Minimum: 1
  • Maximum: 200
  • Default: 10

Response

The successful response returns the collection of run configurations associated with a specific pipeline ID.

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
{
  "items": [
    {
      "id": "67e259e809286e440e2851d9",
      "name": "Test_Run_Config_Name",
      "scheduled": false,
      "compatibilityStatus": true,
      "type": "Batch",
      "published": false,
      "lastModifiedBy": "test@precisely.com",
      "lastModifiedDate": "2025-03-25T07:23:20.209Z"
    }
  ],
  "pageSize": 10,
  "currentPage": 1,
  "totalItems": 1,
  "totalPages": 1
}
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid pipeline id",
  "instance": "/v1/quality/pipelines/{pipelineId}/run-configs",
  "errorCode": "DIS-QUALITY-PIPELINES-USR-0003"
}
{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Pipeline not found",
  "instance": "/v1/quality/pipelines/{pipelineId}/run-configs",
  "errorCode": "DIS-QUALITY-PIPELINES-USR-1001"
}
{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred on the server",
  "instance": "/v1/quality/pipelines/{pipelineId}/run-configs",
  "errorCode": "DIS-QUALITY-PIPELINES-SVC-0001"
}