---
title: "Get a continuous project snapshot"
method: GET
path: "/v1/integration/continuous/projects/{projectId}/snapshot"
tags: ["Build and Configure Continuous Integration Projects"]
---

# Get a continuous project snapshot

`GET /v1/integration/continuous/projects/{projectId}/snapshot`

## Request

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

Retrieves a snapshot for a staged Project.
Snapshot is a full point-in-time picture of the project configuration as it was staged, distinguished by its version number.
It captures project metadata, pipeline definitions, and parameter values at staging time.

**Snapshot lifecycle semantics:**
- Snapshot data is created during stage/commit lifecycle steps
- `LATEST` returns the newest available snapshot
- `ACTIVATED` returns the last deployed baseline snapshot
- The response can be used for drift detection and delta computation in incremental commit/deploy flows

**Request controls:**
- `type` selects which snapshot baseline to retrieve (`LATEST`, `ACTIVATED`)
- `includePipelines` controls whether pipeline details are included

**Required Permissions:** `replication-pipeline::view`

## Path parameters

- `projectId` string, required

## Query parameters

- `type` 'LATEST' | 'ACTIVATED'
- `includePipelines` boolean

## Response `200`

Successfully retrieved project snapshot

- ProjectSnapshotResponse: Response model containing project snapshot details
  - `projectId` string: Unique identifier of the project this snapshot is associated with
  - `projectName` string: Name of the project this snapshot is associated with
  - `projectDescription` string: Description of the project this snapshot is associated with
  - `projectType` 'REPLICATION' | 'MAINFRAME_REPLICATION' | 'ADVANCED_REPLICATION': Type of the project this snapshot is associated with (e.g. COPY, REPLICATION, MAINFRAME_REPLICATION)
  - `createdAt` string, date-time: Timestamp when the project associated with the snapshot was created
  - `createdBy` string: Username of the project owner
  - `modifiedAt` string, date-time: Timestamp when the project associated with the snapshot was last modified
  - `modifiedBy` string: Username of the person who last modified the project associated with the snapshot
  - `committedAt` string, date-time: Timestamp when the project associated with the snapshot was last committed
  - `committedBy` string: Username of the person who committed the project associated with the snapshot
  - `activatedAt` string, date-time: Timestamp when the project associated with the snapshot was last activated
  - `activatedBy` string: Username of the person who activated the project associated with the snapshot
  - `activated` boolean: True if the project associated with the snapshot was activated
  - `version` integer: Snapshot version number
  - `pipelines` ContinuousPipelineResponse[]: List of continuous pipelines captured in this snapshot
    - `id` string: Unique identifier of the pipeline
    - `name` string: Name of the pipeline
    - `description` string: Description of the pipeline
    - `pipelineType` 'SYNCHRONIZE' | 'REPLICATE' | 'COPY': Type of the pipeline (e.g. COPY, REPLICATE, SYNCHRONIZE)
    - `projectId` string: Unique identifier of the project containing this pipeline
    - `source` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `target` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `staging` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `userDatabases` UserDatabaseResponse[]: List of user databases prepared for this pipeline
      - `name` string: Name of the user database
      - `dataConnectionId` string: Identifier of the data connection backing the user database
    - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for all default table mappings in this pipeline
    - `createdAt` string, date-time: Timestamp when the pipeline was created
    - `properties` object: Additional configuration properties for the pipeline
    - `createdBy` string: Username of the pipeline owner
    - `modifiedAt` string, date-time: Timestamp when the pipeline was last modified
    - `modifiedBy` string: Username of the person who last modified the pipeline
    - `tableMappings` ContinuousTableMappingResponse[]: List of table mappings configured for this pipeline
      - `id` string: Unique identifier of the table mapping
      - `sourceDatabase` string: Name of the source database
      - `sourceSchema` string: Name of the source schema
      - `sourceTable` string: Name of the source table
      - `targetDatabase` string: Name of the target database
      - `targetSchema` string: Name of the target schema
      - `targetTable` string: Name of the target table
      - `targetTopic` string: Name of the target topic
      - `targetSubject` string: Name of the target subject for schema registry
      - `type` 'TARGET_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_DOES_NOT_EXIST': Type of the table mapping
      - `hasCustomColMappings` boolean: Flag indicating whether the table has custom column mappings
      - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for this table mapping configuration, this overrides the Metadata fields defined at the pipeline level
      - `schemaVersion` string: Version of the schema used for this mapping
      - `softDeleteColumnName` string: Name of the column used for soft deletes
      - `columnMappings` ColumnMappingResponse[]: List of column mappings for this table
        - `sourceColumnName` string: Name of the source column
        - `targetColumnName` string: Name of the target column
        - `sourceColType` string: Data type of the source column
        - `targetColType` string: Data type of the target column
        - `isDistributionKey` boolean: Flag indicating if this column is used as a distribution key
        - `action` 'Copy' | 'Ignore' | 'SoftDelete': Action to be performed for this column mapping
        - `state` 'TARGET_COLUMN_DATATYPE_NOT_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_COMPATIBLE' | 'NOT_CHECKED': Current state of the column mapping
        - `sourceColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the source column
        - `targetColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the target column
        - `metadataMapping` boolean: Flag indicating if this is a change data records metadata mapping
        - `mappingType` 'FIELD' | 'EXPRESSION' | 'RRN': Type of mapping if this is FIELD / EXPRESSION / RRN
  - `parameters` object: Additional configuration parameters for the project associated with the snapshot

## Other responses

- `400`: Bad request - invalid query parameter value
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Project or snapshot not found
- `500`: Internal server error while retrieving snapshot

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)
