Get pipelines by project ID
Retrieves all continuous data integration pipelines associated with a specific project with pagination and sorting.
Features:
- Pagination support with configurable page size and number
- Pipeline sorting by multiple properties
- Optional connection and mapping details inclusion
- Optional configuration fields inclusion
- Project-specific pipeline filtering
Supported Sort Properties:
- name - Pipeline name
- pipelineType - Pipeline type (COPY, REPLICATE, SYNCHRONIZE, AUDIT)
- createdAt - Creation timestamp
- modifiedAt - Last modification timestamp
- createdBy - Creator user
- modifiedBy - Last modifier user
Optional Data Loading:
- includeConnections - Include source and target connection details
- includeMappings - Include table mapping configurations (columnMappings may be partial for default mappings)
- For fully resolved default/custom column mappings of a specific table mapping, use GET /v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/mappings/{tableMappingId}
- loadConfigs - Include component/config fields (cdc row metadata/user databases) in pipeline responses
Use Cases:
- Browse pipelines within a specific project
- Monitor pipeline status and configuration
- Access pipeline details for management operations
Required Permissions: replication-pipeline::view
Request
- Base URL: https://integration-adapter.connect.cloud.precisely.com
- URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/pipelines
- Auth: HTTP bearer
Path parameters
Unique identifier of the project
Query parameters
Whether to include connection details in the response.
Only effective when includeConnections=true
Whether to include table mapping details in the response. Note: This parameter is only effective when includeConnections parameter is enabled. When includeConnections is disabled, mappings will not be loaded regardless of this parameter value.
Whether to include configuration fields (cdc row metadata/user databases) in pipeline responses
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)
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)
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 pipelines for the project
Example response
{
"content": [
{
"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"
}
]
}
]
}
],
"pageSize": 20,
"numberOfElements": 15,
"totalElements": 157,
"totalPages": 8,
"first": true
}Changes
No recorded changes to this operation across all 1 revision of this API.