Get pipeline by ID - 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 specific continuous data integration pipeline by its unique identifier.

HTML

GET https://hostname/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}

Features

  • Complete pipeline information including metadata and configuration.
  • Optional connection and mapping details inclusion.
  • Pipeline existence validation.
  • Access control enforcement.

Response content

  • Pipeline metadata (name, description, type, timestamps).
  • User information (creator, last modifier).
  • Project association details.
  • Optional connection configurations if requested.
  • Optional table mapping configurations if requested.

Use cases

  • View detailed pipeline information.
  • Check pipeline configuration and status.
  • Access pipeline-specific connection and mapping details.

Required permissions

replication-pipeline::view

Request

Path parameters

Key Required Type Description
projectId Yes string

Specifies the unique identifier of the project containing the pipeline.
pipelineId Yes string

Specifies the unique identifier of the pipeline.

Query parameters

Key Required Type Description
includeConnections No boolean

Specifies whether to include source and target connection details in the response.
includeMappings No boolean

Specifies whether to include table mapping details in the response. Set this to True to include table mapping configurations and column mappings

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

Response

Response body properties

Ancestors Property Required Type Description
  id No string Unique identifier of the pipeline.
Example: "dataflow-456"
  name string No

Name of the pipeline.

Example: "Customer Data Synchronization"
  description No string

Description of the pipeline.

Example: "Synchronizes customer data between systems"
  pipelineType No string

Specifies the type of the pipeline (for example, COPY, REPLICATE, SYNCHRONIZE).

Example: "REPLICATE"
  projectId No string

Specifies the unique identifier of the project containing this pipeline.

Example: "project-123"
  sourceConnectionId No string

Specifies the unique identifier of the source data connection

Example: "conn-src-uuid"
  sourceParameters No object[string]

Configuration parameters for the source connection.
  targetConnectionId No string

Unique identifier of the target data connection.

Example: "conn-tgt-uuid"
  targetParameters No object[string]

Configuration parameters for the target connection
  schemaRegistryId No string

Identifier of the schema registry.

Example: "conn-schema-registry-uuid"
  includedCDCRowMetadata No array[string]

Metadata fields to include with change data records for all default table mappings in this pipeline.
  createdAt No string

Timestamp when the pipeline was created.

Example: "2025-08-24T14:15:22Z"
  properties No object[string]

Additional configuration properties for the pipeline
  createdBy No string

Username of the pipeline owner.

Example: "john.doe@example.com"
  modifiedAt No string

Timestamp when the pipeline was last modified

Example: "2025-08-25T10:30:15Z"
  modifiedBy No string

Username of the person who last modified the pipeline.

Example: "jane.smith@example.com"
  tableMappings No array[object]

List of table mappings configured for this pipeline.
tableMappings id No string

Unique identifier of the table mapping.

Example: "mapping_x688lglh9kq5"
tableMappings sourceDatabase No string

Name of the source database.

Example: "source-database"
tableMappings sourceSchema No string

Name of the source schema.

Example: "source-schema"
tableMappings sourceTable No string

Name of the source table.

Example: "source-table"
tableMappings targetDatabase No string

Name of the target database.

Example: "target-database"
tableMappings targetSchema No string

Name of the target schema.

Example: "target-schema"
tableMappings targetTable No string

Name of the target table.

Example: "target-table"
tableMappings targetTopic No string

Name of the target topic.

Example: "target-topic"
tableMappings targetSubject No string

Name of the target subject for schema registry.

Example: "target-subject"
tableMappings type No string

Type of the table mapping.

Example: "TARGET_EXISTS_WITH_MATCH"
tableMappings hasCustomColMappings No boolean

Flag indicating whether the table has custom column mappings.
tableMappings includedCDCRowMetadata No array[string]

Metadata fields to include with change data records for this table mapping configuration. This overrides the Metadata fields defined at the pipeline level.
tableMappings schemaVersion No string

Version of the schema used for this mapping.

Example: 1
tableMappings softDeleteColumnName No string

Name of the column used for soft deletes.

Example: "soft_delete_column"
tableMappings columnMappings No array[object]

List of column mappings for this table.
tableMappings/columnMappings sourceColumnName No string

Name of the source column.

Example: "source_column"
tableMappings targetColumnName No string

Name of the target column.

Example: "target_column"
tableMappings/columnMappings sourceColType No string

Data type of the source column.

Example: "VARCHAR(50)"
tableMappings/columnMappings targetColType No string

Data type of the target column.

Example: "VARCHAR"
tableMappings/columnMappings action No string

Action to be performed for this column mapping.

Example: "Copy"
tableMappings/columnMappings state No string

Current state of the column mapping.

Example: "ACTIVE"
tableMappings/columnMappings sourceColumnNullableState No string

Nullable state of the source column.

Example: "BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED"
tableMappings/columnMappings targetColumnNullableState No string

Nullable state of the target column.

Example: "NULLABLE_WITH_DEFAULT_VALUE"
tableMappings/columnMappings metadataMapping No boolean

Flag indicating if this is a change data records metadata mapping.
tableMappings/columnMappings mappingType No string

Type of mapping if this is FIELD, EXPRESSION, or RRN.

Example: "FIELD"

Response examples

{
  "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"
        }
      ]
    }
  ]
}
 
{
  "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/{pipelineId}",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
  "title": "Forbidden",
  "status": 403,
  "detail": "Authorization failed - insufficient permissions",
  "instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0002"
  }
}
 
{
  "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/{pipelineId}",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0007"
  }
}
 
{
  "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/{pipelineId}",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0007"
  }
}