Build and Configure Continuous Integration Projects

Get paginated list of projects

Retrieves a paginated list of continuous data integration projects with optional filtering and sorting.

Features:

  • Pagination support with configurable page size and number
  • Optional pipeline details inclusion
  • Optional inclusion of component/config fields (metabases/logreaders)
  • Comprehensive sorting options

Supported Sort Properties:

  • name - Project name
  • projectType - Project type (REPLICATION, COPY)
  • createdAt - Creation timestamp
  • modifiedAt - Last modification timestamp
  • createdBy - Creator user
  • modifiedBy - Last modifier user
  • committedAt - Last commit timestamp
  • deployedAt - Deployment timestamp
  • committedBy - User who committed
  • deployedBy - User who deployed

Use Cases:

  • Browse available projects for dashboard displays
  • Filter projects by type for specific workflows
  • Search and sort projects by various criteria

Required Permissions: replication-pipeline::view

get/v1/integration/continuous/projects

Request

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

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 responses

pageinteger

Zero-based page index (0..N).

Validation Rules:

  • Must be greater than or equal to 0
  • Default: 0 (first page)

Examples:

  • page=0 (first page)
  • page=1 (second page)
  • page=5 (sixth page)
sizeinteger

The number of items to return per page.

Validation Rules:

  • Must be between 1 and 100 (inclusive)
  • Default: 10 items per page
  • Values exceeding 100 will return validation error

Examples:

  • size=10 (10 items per page)
  • size=50 (50 items per page)
  • size=100 (maximum allowed)
sortstring[]

Sorting criteria with flexible format options. Multiple sort parameters supported for multi-level sorting.

Default: name,asc (sort by name in ascending order)

Sort Format Options:

  • sort=property (e.g., sort=name - defaults to ascending)
  • sort=property,direction (e.g., sort=name,asc or sort=createdAt,desc)
  • sort=property,asc,ignoreCase (for case-insensitive sorting)

Multi-level Sorting:

  • sort=property1,asc&sort=property2,desc (multiple sort parameters)
  • First sort criteria takes priority, subsequent ones used for tie-breaking

Note: Supported sort properties vary by endpoint. Check the specific endpoint documentation for the list of valid sort properties for that resource type.

Examples:

  • sort=name,asc (sort by name ascending)
  • sort=createdAt,desc (sort by creation date descending)
  • sort=type,asc&sort=name,asc (multi-level sort)
  • sort=deployedAt,desc,ignoreCase (case-insensitive sort)

Response

Successfully retrieved project list

pageNumberinteger

Zero-based page number

pageSizeinteger

Number of items per page (requested size)

numberOfElementsinteger

Actual number of projects in the current page

totalElementsinteger

Total number of projects across all pages

totalPagesinteger

Total number of pages available

firstboolean

Indicates if this is the first page

lastboolean

Indicates if this is the last page

Example response

{
  "content": [
    {
      "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"
        }
      ]
    }
  ],
  "pageSize": 20,
  "numberOfElements": 15,
  "totalElements": 157,
  "totalPages": 8,
  "first": true
}

Changes

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