Build and Configure Mainframe Integration Projects

Configure table mappings for a mainframe pipeline

Configures source-to-target table mappings for a specified pipeline within a mainframe integration project.

Process Overview:

  1. Resource Validation - Validates project and pipeline existence
  2. Mapping Configuration - Applies source-to-target table mappings, supporting RDBMS source to RDBMS target type mappings)
  3. Customization - Allows per-source customization (schema casing, table casing and column casing)
  4. Validation & Persistence - Validates and saves the mapping configuration

Use Cases:

  • Define or update table mappings for a pipeline
  • Support advanced mapping scenarios (schema casing, table casing and column casing)
  • Integrate with RDBMS source to RDBMS target type mapping for a reverse-sync mainframe pipeline

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

post/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/mappings

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}/mappings
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The unique identifier of the project containing the pipeline

pipelineIdstring required

The unique identifier of the pipeline to configure mappings for

Request body

Example request

{
  "mappings": [
    {
      "source": {
        "schemaCase": "NONE",
        "tableCase": "NONE",
        "columnCase": "NONE"
      }
    }
  ]
}

Response

Table mappings configured successfully

idstring

Unique identifier of the table mapping

sourceDatabasestring

Name of the source database

sourceSchemastring

Name of the source schema

sourceTablestring

Name of the source table

targetDatabasestring

Name of the target database

targetSchemastring

Name of the target schema

targetTablestring

Name of the target table

targetTopicstring

Name of the target topic

targetSubjectstring

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.

Example response

{
  "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.