---
title: "Get mainframe pipeline by ID"
method: GET
path: "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}"
tags: ["Build and Configure Mainframe Integration Projects"]
---

# Get mainframe pipeline by ID

`GET /v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}`

## Request

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

Retrieves a specific mainframe data integration pipeline by its unique identifier.

**Features:**
- Complete pipeline information including metadata and configuration
- Optional section-based data loading for granular details
- Pipeline existence validation
- Access control enforcement

**Response Content:**
- Pipeline metadata (name, description, type, timestamps)
- User information (creator, last modifier, deployer)
- Project association details
- Optional section details if requested

**Optional Data Loading:**
- `sections` - Include specific pipeline sections in the response (e.g., DATA_CONNECTION_SECTION, SUMMARY_SECTION)

**Use Cases:**
- View detailed pipeline information
- Check pipeline configuration and status
- Access pipeline-specific section details

**Required Permissions:** `replication-pipeline::view`

## Path parameters

- `projectId` string, required
- `pipelineId` string, required

## Query parameters

- `sections` string[]

## Response `200`

Successfully retrieved mainframe pipeline details

- MainframePipelineResponse: Response model containing mainframe pipeline information
  - `id` string: Unique identifier of the mainframe pipeline
  - `name` string: Name of the mainframe pipeline
  - `internalName` string: Internal system name used for the pipeline
  - `agents` MainframeAgent[]: Agents associated with this pipeline
    - `type` 'APPLY_ENGINE' | 'STREAM_PUBLISHER' | 'REPLICATOR': Type of the mainframe agent.
    - `name` string: Name of the agent.
  - `description` string: Description of the pipeline purpose and functionality
  - `pipelineType` 'NONE' | 'ENGINE_VSAM' | 'ENGINE_IMS' | 'ENGINE_DB2' | 'ENGINE_KAFKA' | 'REPLICATOR_VSAM' | 'REPLICATOR_IMS' | 'REPLICATOR_DB2' | 'REPLICATOR_DEFAULT': Type of mainframe pipeline, defining its purpose and behavior
  - `replicationType` 'ENGINE' | 'REPLICATOR': Type of mainframe replication
  - `runtimeEngineId` string: Identifier of the runtime engine associated with this pipeline
  - `entryFileId` string: Identifier of the entry file for this pipeline
  - `configJsonFileId` string: Identifier of the configuration JSON file for this pipeline
  - `projectId` string: Identifier of the project this pipeline belongs to
  - `autoStart` boolean: Flag indicating whether the pipeline should automatically start when deployed
  - `stagePipelineConfiguration` boolean: Flag indicating whether to stage the pipeline configuration
  - `activatePipelineConfiguration` boolean: Flag indicating whether to activate the pipeline configuration
  - `pipelineState` 'UNKNOWN' | 'CREATING' | 'CREATED' | 'EDITED' | 'STAGED_WITH_SUCCESS' | 'STAGED_WITH_ERROR' | 'DEPLOYED_WITH_SUCCESS': Current state of the pipeline
  - `sourceDataConnectionId` string: Identifier of the data connection used as the source for this pipeline
  - `targetDataConnectionId` string: Identifier of the data connection used as the target for this pipeline
  - `selectedResources` MainframeSelectedResources: Selected resources for mainframe pipeline, including source and target assets.
    - `source` SelectedAssets: Assets selected for a mainframe endpoint, including database, schemas/tables, and topics.
      - `database` string: Name of the selected database.
      - `schemasAndTables` SchemaTables[]: List of selected schemas and associated tables.
        - `schema` string, required: Selected schema.
        - `tables` string[], required: List of selected tables in the schema.
      - `topics` string[]: List of selected topics.
    - `target` SelectedAssets: Assets selected for a mainframe endpoint, including database, schemas/tables, and topics.
      - `database` string: Name of the selected database.
      - `schemasAndTables` SchemaTables[]: List of selected schemas and associated tables.
        - `schema` string, required: Selected schema.
        - `tables` string[], required: List of selected tables in the schema.
      - `topics` string[]: List of selected topics.
  - `cdcFieldMappings` CDCFieldMappings: CDC field mapping configuration
    - `sourceMessageProducerFormat` 'custom' | 'precisely_replication' | 'debezium', required: Source message producer format
    - `fieldMappings` FieldMapping[], required: Field mappings for CDC
      - `sourceField` string: Source field name
      - `targetField` string, required: Target field name
      - `valueMappings` object: Value mappings for the field
  - `createdBy` string: User who created the pipeline
  - `modifiedBy` string: User who last modified the pipeline
  - `deployedBy` string: User who deployed the pipeline
  - `committedAt` string, date-time: Date and time when the pipeline was last committed
  - `deployedAt` string, date-time: Date and time when the pipeline was last deployed
  - `validatedAt` string, date-time: Date and time when the pipeline was last validated
  - `tableMappings` MainframeTableMappingResponse[]: List of table mappings configured for this pipeline
    - `id` string: Unique identifier of the table mapping
    - `sourceDatabase` string: Name of the source database
    - `sourceSchema` string: Name of the source schema
    - `sourceTable` string: Name of the source table
    - `targetDatabase` string: Name of the target database
    - `targetSchema` string: Name of the target schema
    - `targetTable` string: Name of the target table
    - `targetTopic` string: Name of the target topic
    - `targetSubject` string: Name of the target subject for schema registry
    - `sourceSchemaCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source schema names. Default is NONE.
    - `sourceTableCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source table names. Default is NONE.
    - `sourceColumnCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source column names. Default is NONE.

## Other responses

- `400`: Bad Request - Invalid pipeline ID format
- `403`: Forbidden - Insufficient permissions to access pipeline data
- `404`: Not Found - Pipeline with the specified ID does not exist
- `500`: Internal Server Error - Failed to retrieve pipeline

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)