Build and Configure Continuous Integration Projects

Get pipeline by ID

Retrieves a specific continuous data integration pipeline by its unique identifier.

Features:

Complete pipeline information including metadata and configuration
Optional connection and mapping details inclusion
Optional configuration fields 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
Optional configuration fields (cdc row metadata/user databases)

Optional Data Loading:

includeConnections - Include source and target connection details
includeMappings - Include table mapping configurations and column mappings (default mappings may not be fully expanded)
To fetch a fully resolved mapping (including default column mappings), use GET /v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/mappings/{tableMappingId}

Use Cases:

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

Required Permissions: replication-pipeline::view

get/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}

Request

Base URL: https://integration-adapter.connect.cloud.precisely.com
URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}
Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project containing the pipeline

pipelineIdstring required

Unique identifier of the pipeline

Query parameters

includeConnectionsboolean

Whether to include connection details in the response.

includeMappingsboolean

Only effective when includeConnections=true

Whether to include table mapping details in the response. Note: This parameter is only effective when loadConnections parameter is enabled. When loadConnections is disabled, mappings will not be loaded regardless of this parameter value.

loadConfigsboolean

Whether to include configuration fields (cdc row metadata/user databases) in pipeline response

Response

Successfully retrieved the pipeline

idstring

Unique identifier of the pipeline

namestring

Name of the pipeline

descriptionstring

Description of the pipeline

pipelineType'SYNCHRONIZE' | 'REPLICATE' | 'COPY'

Type of the pipeline (e.g. COPY, REPLICATE, SYNCHRONIZE)

projectIdstring

Unique identifier of the project containing this pipeline

includedCDCRowMetadatastring[]

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

createdAtstring date-time

Timestamp when the pipeline was created

propertiesobject

Additional configuration properties for the pipeline

createdBystring

Username of the pipeline owner

modifiedAtstring date-time

Timestamp when the pipeline was last modified

modifiedBystring

Username of the person who last modified the pipeline

Example response

{
  "id": "dataflow-456",
  "name": "Customer Data Synchronization",
  "description": "Synchronizes customer data between systems",
  "pipelineType": "REPLICATE",
  "projectId": "project-123",
  "source": {
    "id": "conn-uuid",
    "name": "Primary Source Connection",
    "type": "DB2I"
  },
  "target": {
    "id": "conn-uuid",
    "name": "Primary Source Connection",
    "type": "DB2I"
  },
  "staging": {
    "id": "conn-uuid",
    "name": "Primary Source Connection",
    "type": "DB2I"
  },
  "userDatabases": [
    {
      "name": "USERDB1",
      "dataConnectionId": "conn-db-uuid"
    }
  ],
  "createdAt": "2025-08-24T14:15:22Z",
  "createdBy": "john.doe@example.com",
  "modifiedAt": "2025-08-25T10:30:15Z",
  "modifiedBy": "jane.smith@example.com",
  "tableMappings": [
    {
      "id": "mapping_x688lglh9kq5",
      "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,
      "softDeleteColumnName": "soft_delete_column",
      "columnMappings": [
        {
          "sourceColumnName": "ACCOUNT_ID",
          "targetColumnName": "ACCOUNT_ID",
          "sourceColType": "INTEGER",
          "targetColType": "INT64",
          "isDistributionKey": true,
          "action": "Copy",
          "state": "BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED",
          "sourceColumnNullableState": "NON_NULLABLE_WITHOUT_DEFAULT_VALUE",
          "targetColumnNullableState": "NON_NULLABLE_WITHOUT_DEFAULT_VALUE",
          "mappingType": "FIELD"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.