Build and Configure Mainframe Integration Projects

Get mainframe pipeline by ID

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

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

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

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

Response

Successfully retrieved mainframe pipeline details

idstring

Unique identifier of the mainframe pipeline

namestring

Name of the mainframe pipeline

internalNamestring

Internal system name used for the pipeline

descriptionstring

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

runtimeEngineIdstring

Identifier of the runtime engine associated with this pipeline

entryFileIdstring

Identifier of the entry file for this pipeline

configJsonFileIdstring

Identifier of the configuration JSON file for this pipeline

projectIdstring

Identifier of the project this pipeline belongs to

autoStartboolean

Flag indicating whether the pipeline should automatically start when deployed

stagePipelineConfigurationboolean

Flag indicating whether to stage the pipeline configuration

activatePipelineConfigurationboolean

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

sourceDataConnectionIdstring

Identifier of the data connection used as the source for this pipeline

targetDataConnectionIdstring

Identifier of the data connection used as the target for this pipeline

createdBystring

User who created the pipeline

modifiedBystring

User who last modified the pipeline

deployedBystring

User who deployed the pipeline

committedAtstring date-time

Date and time when the pipeline was last committed

deployedAtstring date-time

Date and time when the pipeline was last deployed

validatedAtstring date-time

Date and time when the pipeline was last validated

Example response

{
  "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"
    }
  ]
}

Changes

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