Get pipelines for a project - 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 all continuous data integration pipelines associated with a specific project with pagination and sorting.

HTML

GET https://hostname/v1/integration/continuous/projects/{projectId}/pipelines
Features
  • Pagination support with configurable page size and number
  • Pipeline sorting by multiple properties
  • Optional connection and mapping details inclusion
  • Project-specific pipeline filtering
Use cases
  • Browse pipelines within a specific project
  • Monitor pipeline status and configuration
  • Access pipeline details for management operations
Required permissions
replication-pipeline::view

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project.

Query parameters

Key Required Type Description
includeConnections No boolean

Set to True to include source and target connection details in the response.

includeMappings No boolean

Set to True to include table mapping details in the response.

This parameter is only effective when includeConnections parameter is enabled. When includeConnections is disabled, mappings will not be loaded regardless of this parameter value.

page No integer Zero-based page index (0..N).Validation Rules:
  • Must be greater than or equal to 0.
  • Default: 0 (first page)

Examples:

  • page=0 (first page)
  • page=1 (second page)
  • page=5 (sixth page)
size No integer

The number of items to return per page. Validation Rules:

  • Must be between 1 and 100 (inclusive)
  • Default: 10 items per page
  • Values exceeding 100 will return validation error.

Examples:

  • size=10 (10 items per page)
  • size=50 (50 items per page)
  • size=100 (maximum allowed)
sort No array

Sorting criteria with flexible format options. Multiple sort parameters supported for multi-level sorting.

The sort criteria specify sort format, direction, and whether to ignore case. The defaults are by name (name) in ascending order (asc).

Sort properties:

  • name—Pipeline name
  • pipelineType—Pipeline type (COPY, REPLICATE, SYNCHRONIZE, AUDIT)
  • createdAt—Creation timestamp
  • modifiedAt—Last modification timestamp
  • createdBy—Creator user
  • modifiedBy—Last modifier user

Search direction:

  • asc Sort in ascending order (default).
  • desc Sort in descending order

Search strings:

  • sort=property For example, name sorts by name in ascending order by default.
  • sort=property,direction For example, sort=name,asc sorts by name in ascending order, and sort=createdAt,desc descending order.
  • sort=property,direction,ignoreCase Specifies case insensitive sorting.

Multi-level sorting:

  • sort=property1,asc&sort=property2,desc

The primary criterion is used first, and any ties are then resolved iteratively using subsequent criteria.

Note:

Supported sort properties vary by endpoint. Check the specific endpoint documentation for the list of valid sort properties for a particular resource type.

Response

Response examples

{
  "content": [
    {
      "id": "dataflow-456",
      "name": "Customer Data Synchronization",
      "description": "Synchronizes customer data between systems",
      "pipelineType": "REPLICATE",
      "projectId": "project-123",
      "sourceConnectionId": "conn-src-uuid",
      "sourceParameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "targetConnectionId": "conn-tgt-uuid",
      "targetParameters": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "schemaRegistryId": "conn-schema-registry-uuid",
      "includedCDCRowMetadata": [
        "string"
      ],
      "createdAt": "2025-08-24T14:15:22Z",
      "properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "createdBy": "john.doe@example.com",
      "modifiedAt": "2025-08-25T10:30:15Z",
      "modifiedBy": "jane.smith@example.com",
      "tableMappings": [
        {
          "sourceDatabase": "source-database",
          "sourceSchema": "source-schema",
          "sourceTable": "source-table",
          "targetDatabase": "target-database",
          "targetSchema": "target-schema",
          "targetTable": "target-table",
          "targetTopic": "target-topic",
          "targetSubject": "target-subject",
          "type": "TARGET_EXISTS_WITH_MATCH",
          "hasCustomColMappings": true,
          "includedCDCRowMetadata": [
            "string"
          ],
          "schemaVersion": "1",
          "softDeleteColumnName": "soft_delete_column",
          "columnMappings": [
            {
              "sourceColumnName": "source_column",
              "targetColumnName": "target_column",
              "sourceColType": "VARCHAR(50)",
              "targetColType": "VARCHAR",
              "action": "Copy",
              "state": "ACTIVE",
              "sourceColumnNullableState": "BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED",
              "targetColumnNullableState": "NULLABLE_WITH_DEFAULT_VALUE",
              "metadataMapping": false,
              "mappingType": "FIELD"
            }
          ]
        }
      ]
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "numberOfElements": 15,
  "totalElements": 157,
  "totalPages": 8,
  "first": true,
  "last": false
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation error occurred",
  "instance": "/v1/integration/continuous/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authorization failed - missing or invalid credentials",
  "instance": "/v1/integration/continuous/projects/{projectId}",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0001"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation error occurred",
  "instance": "/v1/integration/continuous/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found - Resource does not exist",
  "instance": "/v1/integration/continuous/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-PRJ-0005"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found - Resource does not exist",
  "instance": "/v1/integration/continuous/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-PRJ-0005"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected error occurred",
  "instance": "/v1/integration/continuous/projects/{projectId}",
  "properties": {
    "errorCode": "DI-ADAPTER-PRJ-0002"
  }
}