Build and Configure Mainframe Integration Projects

Get mainframe pipelines by project ID

Retrieves all mainframe 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 section-based data loading for pipeline details
Project-specific pipeline filtering

Supported Sort Properties:

name - Pipeline name
internalName - Internal pipeline name
pipelineType - Pipeline type
replicationType - Replication type
pipelineState - Pipeline state
committedAt - Commit timestamp
deployedAt - Deploy timestamp
validatedAt - Validation timestamp
createdBy - Creator user
modifiedBy - Last modifier user
deployedBy - Deployer user

Optional Data Loading:

sections - Include specific pipeline sections in the response (e.g., DATA_CONNECTION_SECTION, SUMMARY_SECTION)

Use Cases:

Browse mainframe pipelines within a specific project
Monitor pipeline status and configuration
Access pipeline details for management operations

Required Permissions: replication-pipeline::view

get/v1/integration/mainframe/projects/{projectId}/pipelines

Request

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

Path parameters

projectIdstring required

Unique identifier of the project

Query parameters

sectionsstring[]

Set of pipeline sections to include in the response.

Allowed values:

[] (empty): No sections selected
Any combination of section enums except ALL_SECTIONS
[ALL_SECTIONS] alone

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 mainframe pipelines for the project

pageNumberinteger

Zero-based page number

pageSizeinteger

Number of items per page (requested size)

numberOfElementsinteger

Actual number of pipelines in the current page

totalElementsinteger

Total number of pipelines 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": "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"
        }
      ]
    }
  ],
  "pageSize": 20,
  "numberOfElements": 15,
  "totalElements": 157,
  "totalPages": 8,
  "first": true
}

Changes

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