Get project 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 project by its unique identifier.

HTML

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

Features

Complete project information including metadata and configuration
Optional pipeline details inclusion
Project existence validation
Access control enforcement

Response content

Project metadata (name, description, type, timestamps)
User information (creator, last modifier)
Optional pipeline configurations if requested

Use cases

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

Required permissions

replication-pipeline::view

Request

Path parameters

Key	Required	Type	Description
projectId	Yes	string	The unique identifier of the project to retrieve.

Query parameters

Key	Required	Type	Description
includePipelines	No	boolean	Flag to determine if pipeline details should be included with project details.

Response

The successful response returns the integration project.

Response examples

{
  "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",
  "parameters": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "pipelines": [
    {
      "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}",
  "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.4",
  "title": "Forbidden",
  "status": 403,
  "detail": "Authorization failed - insufficient permissions",
  "instance": "/v1/integration/continuous/projects/{projectId}",
  "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}",
  "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"
  }
}