Build and Configure Continuous Integration Projects

Configure table mappings for a pipeline

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

Process Overview:

  1. Resource Validation - Validates project and pipeline existence
  2. Mapping Configuration - Applies source-to-target table mappings, supporting polymorphic source/target types (RDBMS, Kafka, Schema Registry)
  3. Customization - Allows per-target customization (column mappings, metadata fields)
  4. Fallback Logic - If columnMappings or includedCDCRowMetadata are not provided, defaults to exact mapping
  5. Validation & Persistence - Validates and saves the mapping configuration

Update Mode (mode query parameter):

  • ADD (default): Merges request body mappings with existing pipeline mappings. Incoming mappings win on duplicate source/target signatures; unmentioned existing mappings are preserved.
  • REPLACE: Discards all existing table mappings and stores only the mappings in the request body.

Use Cases:

  • Define or update table mappings for a pipeline
  • Incrementally add new source/target pairs without disrupting existing mappings (ADD)
  • Update individual mapping configurations (e.g., column mappings) without affecting others (ADD)
  • Fully reconfigure all table mappings for a pipeline (REPLACE)
  • Support advanced mapping scenarios (custom columns, metadata)
  • Integrate with multiple source/target types

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

post/v1/integration/continuous/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/continuous/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

Query parameters

mode'ADD' | 'REPLACE'

Controls how submitted table mappings are applied to the pipeline.

ADD (default) Keeps the mappings that are already configured on the pipeline and applies the mappings from this request on top of them.

REPLACE Removes the existing mappings and stores only the mappings provided in this request.

Use ADD for incremental updates. Use REPLACE when this request should become the full mapping definition for the pipeline.

Note: The value must match one of the enum constant names exactly (case-sensitive). Valid values are: ADD, REPLACE. Invalid values will result in a 400 Bad Request error.

Request body

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

type'TARGET_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_DOES_NOT_EXIST'

Type of the table mapping

hasCustomColMappingsboolean

Flag indicating whether the table has custom column mappings

includedCDCRowMetadatastring[]

Metadata fields to include with change data records for this table mapping configuration, this overrides the Metadata fields defined at the pipeline level

schemaVersionstring

Version of the schema used for this mapping

softDeleteColumnNamestring

Name of the column used for soft deletes

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",
  "type": "TARGET_EXISTS_WITH_MATCH",
  "hasCustomColMappings": true,
  "softDeleteColumnName": "soft_delete_column",
  "columnMappings": [
    {
      "sourceColumnName": "ACCOUNT_ID",
      "targetColumnName": "ACCOUNT_ID",
      "sourceColType": "INTEGER",
      "targetColType": "INT64",
      "isDistributionKey": true,
      "action": "Copy",
      "state": "BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED",
      "sourceColumnNullableState": "NON_NULLABLE_WITHOUT_DEFAULT_VALUE",
      "targetColumnNullableState": "NON_NULLABLE_WITHOUT_DEFAULT_VALUE",
      "mappingType": "FIELD"
    }
  ]
}

Changes

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