Build and Configure Continuous Integration Projects

Get a continuous project snapshot

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

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

Path parameters

projectIdstring required

Project identifier

Query parameters

type'LATEST' | 'ACTIVATED'

Snapshot baseline to retrieve

includePipelinesboolean

Include pipeline details in the snapshot response

Response

Successfully retrieved project snapshot

projectIdstring

Unique identifier of the project this snapshot is associated with

projectNamestring

Name of the project this snapshot is associated with

projectDescriptionstring

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)

createdAtstring date-time

Timestamp when the project associated with the snapshot was created

createdBystring

Username of the project owner

modifiedAtstring date-time

Timestamp when the project associated with the snapshot was last modified

modifiedBystring

Username of the person who last modified the project associated with the snapshot

committedAtstring date-time

Timestamp when the project associated with the snapshot was last committed

committedBystring

Username of the person who committed the project associated with the snapshot

activatedAtstring date-time

Timestamp when the project associated with the snapshot was last activated

activatedBystring

Username of the person who activated the project associated with the snapshot

activatedboolean

True if the project associated with the snapshot was activated

versioninteger

Snapshot version number

parametersobject

Additional configuration parameters for the project associated with the snapshot

Example response

{
  "projectId": "project-123",
  "projectName": "Customer Data Integration Project",
  "projectDescription": "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",
  "activatedAt": "2025-08-25T12:00:00Z",
  "activatedBy": "admin@precisely.com",
  "activated": true,
  "version": 5,
  "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"
            }
          ]
        }
      ]
    }
  ]
}

Changes

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