Build and Configure Mainframe Integration Projects

Create a new mainframe pipeline

Creates a new mainframe data integration pipeline in a mainframe project. If the pipeline is successfully created, the response includes the pipeline and project identifiers in the response body.

Process Overview:

  • This endpoint validates the request and determines whether to create a sync or reverse sync pipeline based on the provided configuration.
  • For syncConfig: Validates connection types, runtime engine, and replication mode, then creates a sync pipeline.
  • For reverseSyncConfig: Validates connection types, then creates a reverse sync pipeline and associates connections.
  • Uses the supplied projectId when provided; otherwise resolves the project from projectName by validating/finding/creating the mainframe project.
  • For reverse sync operations, associates the connections with the created pipeline.
  • Returns project and pipeline IDs, and replication type in the response body.

Key Features:

  • Enables users to create and configure mainframe data integration pipelines.
  • Supports both sync and reverse sync pipeline creation.
  • Returns identifiers and replication type for further operations.

Required Permissions: replication-pipeline::create when permission harmonization is enabled; otherwise, replication-pipeline::manage.

post/v1/integration/mainframe/pipelines

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/pipelines
  • Auth: HTTP bearer

Request body

projectIdstring

Project ID. When supplied, the pipeline is created directly under this project.

projectNamestring

Project name. Used only when projectId is omitted.

pipelineNamestring

Pipeline name

descriptionstring

Description of the replication pipeline

Example request

{
  "projectId": "project-123",
  "projectName": "Mainframe-Project",
  "pipelineName": "Mainframe-Pipeline-1",
  "description": "Pipeline for synchronizing customer data between systems",
  "syncConfig": {
    "runTimeEngineName": "Engine1"
  },
  "reverseSyncConfig": {
    "sourceConnectionId": "67fccf1e836cb73b44f6c038",
    "targetConnectionId": "67fccf97836cb73b44f6c058"
  },
  "replicationSettings": {
    "sourceConnectionType": "VSAM",
    "targetConnectionType": "KAFKA",
    "autoStart": true,
    "replicationMode": "ADVANCED"
  }
}

Response

Pipeline successfully created and configured

projectIdstring

ID of the project containing the pipeline. This is the project that was either found or created during the pipeline creation process.

pipelineIdstring

ID of the created pipeline. This identifier can be used to query the pipeline status, modify its configuration, or manage its lifecycle.

replicationType'ENGINE' | 'REPLICATOR'

Type of mainframe replication configured for the pipeline.

Example response

{
  "projectId": "data-integration-project-id-123",
  "pipelineId": "customer-data-synchronization-pipeline-456",
  "replicationType": "MAINFRAME_REPLICATION_TYPE_ENGINE"
}

Changes

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