Get projects - 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 paginated list of continuous data integration projects with optional filtering and sorting.

HTML

GET https://hostname/v1/integration/continuous/projects

Features

  • Pagination support with configurable page size and number
  • Optional pipeline details inclusion
  • Comprehensive sorting options

Use cases

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

Request

Query parameters

Key Required Type Description
includePipelines No boolean

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

page No integer

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

Validation rules:

  • Must be greater than or equal to 0.
  • Default: 0 (first page)
Example values:
  • 0 (first page)
  • 1 (second page)
  • 5 (sixth page)
size No integer

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.

Example values:

  • 10 (10 items per page)
  • 50 (50 items per page)
  • 100 (maximum allowed)
sort No array

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

The sort criteria specify sort format, direction, and whether to ignore case. The defaults are by name (name), in ascending order asc, and case-sensitive sorting.

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

Search direction:

  • asc Sort in ascending order (default).
  • desc Sort in descending order

Example search strings:

  • sort=property For example, name sorts by name in ascending order.
  • sort=property,direction For example, sort=name,asc sorts by name in ascending order, and sort=createdAt,desc sorts by timestamp from newest to oldest.
  • sort=property,direction,ignoreCase Specifies case insensitive sorting.

Multi-level sorting:

  • sort=property1,asc&sort=property2,desc

The primary criterion is used first, and any ties are then resolved iteratively using subsequent criteria.

Note:

Supported sort properties vary by endpoint. Check the specific endpoint documentation for the list of valid sort properties for a particular resource type.

Responses

The successful response returns the collection of projects that match the filter criteria.

Response body

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Integration API specification (Precisely Integration Adapter Service) from the Precisely Developer Portal..

Examples
{
  "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",
      "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"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "numberOfElements": 15,
  "totalElements": 157,
  "totalPages": 8,
  "first": true,
  "last": false
}
{
  "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",
  "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",
  "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",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0002"
  }
}
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity - Request is syntactically correct but semantically invalid",
  "instance": "/v1/integration/continuous/projects",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0001"
  }
}
{
  "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",
  "properties": {
    "errorCode": "DI-ADAPTER-PRJ-0001"
  }
}