Build and Configure Continuous Integration Projects

Get project by ID

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

Features:

  • Complete project information including metadata and configuration
  • Optional pipeline details inclusion
  • Metabase and LogReader details if configured
  • Project existence validation
  • Access control enforcement

Response Content:

  • Project metadata (name, description, type, timestamps)
  • User information (creator, last modifier)
  • Optional pipeline details if requested
  • Optional configuration sections (metabases, logreaders) if requested

Use Cases:

  • View detailed project information
  • Check project configuration and status
  • Access project-specific pipeline details

Required Permissions: replication-pipeline::view

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

Request

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

Path parameters

projectIdstring required

The unique identifier of the project to retrieve

Query parameters

includePipelinesboolean

Flag to determine if pipeline details should be included with project details

loadConfigsboolean

Whether to include component/config fields (metabases/logreaders) in project response

Response

Successfully retrieved project details

idstring

Unique identifier of the project

namestring

Name of the project

descriptionstring

Description of the project

projectType'REPLICATION' | 'MAINFRAME_REPLICATION' | 'ADVANCED_REPLICATION'

Type of the project (e.g. COPY, REPLICATION, MAINFRAME_REPLICATION)

createdAtstring date-time

Timestamp when the project was created

createdBystring

Username of the person who created the project

modifiedAtstring date-time

Timestamp when the project was last modified

modifiedBystring

Username of the person who last modified the project

committedAtstring date-time

Timestamp when the project was last committed

committedBystring

Username of the person who committed the project

deployedAtstring date-time

Timestamp when the project was last deployed

deployedBystring

Username of the person who deployed the project

parametersobject

Configuration parameters for the project

Example response

{
  "id": "project-123",
  "name": "Customer Data Integration Project",
  "description": "Integration project for customer data synchronization",
  "projectType": "REPLICATION",
  "createdAt": "2025-08-24T14:15:22Z",
  "createdBy": "john.doe@example.com",
  "modifiedAt": "2025-08-25T10:30:15Z",
  "modifiedBy": "jane.smith@example.com",
  "committedAt": "2025-08-25T11:45:30Z",
  "committedBy": "jane.smith@example.com",
  "deployedAt": "2025-08-25T12:00:00Z",
  "deployedBy": "admin@precisely.com",
  "validationSummary": {
    "status": "COMPLETED",
    "message": "DSL validation completed: DSL_ONLY=PASSED; FULL=FAILED",
    "lastValidatedAt": "2026-08-13T12:43:40.875Z",
    "scopeStatuses": [
      {
        "scope": "DSL_ONLY",
        "status": "FAILED"
      }
    ]
  },
  "pipelines": [
    {
      "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"
            }
          ]
        }
      ]
    }
  ],
  "advancedPipelines": [
    {
      "id": "66b6e4c7e74f5f12ab345678",
      "name": "customer-replication",
      "description": "Replicate customer records to Snowflake",
      "type": "REPLICATE",
      "runOnHost": "engine-east-1",
      "sourceFile": "pipelines/customer.dis.yaml",
      "line": 14,
      "column": 3,
      "validationStatus": "PASSED",
      "validationMessage": "Pipeline validation passed",
      "lastValidatedAt": "2026-08-12T06:22:07Z"
    }
  ],
  "mainframePipelines": [
    {
      "id": "mainframe-pipeline-001",
      "name": "CustomerMainframePipeline",
      "internalName": "customer_mainframe_pipeline_internal",
      "agents": [
        {
          "type": "APPLY_ENGINE",
          "name": "agent-1"
        }
      ],
      "description": "Synchronizes customer data from mainframe to cloud.",
      "replicationType": "MAINFRAME_REPLICATION_TYPE_ENGINE",
      "runtimeEngineId": "runtime-engine-123",
      "entryFileId": "entry-file-abc",
      "configJsonFileId": "config-json-xyz",
      "projectId": "project-789",
      "autoStart": true,
      "stagePipelineConfiguration": true,
      "activatePipelineConfiguration": true,
      "pipelineState": "PIPELINE_STATE_DEPLOYED_WITH_SUCCESS",
      "sourceDataConnectionId": "source-conn-001",
      "targetDataConnectionId": "target-conn-002",
      "selectedResources": {
        "source": {
          "database": "sourceDatabase",
          "schemasAndTables": [
            {
              "schema": "targetSchema",
              "tables": [
                "targetTable1",
                "targetTable2"
              ]
            }
          ],
          "topics": [
            "sourceTopic1",
            "sourceTopic2"
          ]
        },
        "target": {
          "database": "sourceDatabase",
          "schemasAndTables": [
            {
              "schema": "targetSchema",
              "tables": [
                "targetTable1",
                "targetTable2"
              ]
            }
          ],
          "topics": [
            "sourceTopic1",
            "sourceTopic2"
          ]
        }
      },
      "cdcFieldMappings": {
        "fieldMappings": [
          {
            "sourceField": "sv_sending_table",
            "targetField": "Dataset name"
          }
        ]
      },
      "createdBy": "john.doe@example.com",
      "modifiedBy": "jane.smith@example.com",
      "deployedBy": "carol.white@example.com",
      "committedAt": "2025-11-06T09:17:47Z",
      "deployedAt": "2025-11-06T10:00:00Z",
      "validatedAt": "2025-11-06T10:30:00Z",
      "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",
          "sourceSchemaCase": "NONE",
          "sourceTableCase": "NONE",
          "sourceColumnCase": "NONE"
        }
      ]
    }
  ],
  "metabases": [
    {
      "name": "metabase-source-1",
      "version": "1.0.0",
      "dataConnectionId": "conn-metabase-uuid",
      "vaultConnectionId": "vault-conn-uuid"
    }
  ],
  "logreaders": [
    {
      "name": "logreader-1",
      "journal": "JRN001",
      "dataConnectionId": "conn-src-uuid"
    }
  ]
}

Changes

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