Build and Configure Continuous Integration Projects

Get table mapping by ID

Retrieves a specific table mapping with resolved column mappings for the given project and pipeline.

Features

  • Returns the authoritative mapping payload for a specific tableMappingId
  • Includes both user-defined custom mappings and backend-resolved default mappings
  • Supports optional schemaVersion for SCHEMA_REGISTRY targets only (keep empty for all other target types)

Use cases

  • Inspect one mapping in detail before applying mapping updates
  • Troubleshoot mapping output when pipeline/project retrieval does not include fully expanded defaults

Parameters:

  • projectId - Project identifier
  • pipelineId - Pipeline identifier
  • tableMappingId - Table mapping identifier
  • schemaVersion (optional) - Use only for SCHEMA_REGISTRY targets; keep empty for non-schema-registry targets

Required Permissions: replication-pipeline::view

get/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/mappings/{tableMappingId}

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

Path parameters

projectIdstring required

Project identifier

pipelineIdstring required

Pipeline identifier

tableMappingIdstring required

Table mapping identifier

Query parameters

schemaVersionstring

Optional schema version for SCHEMA_REGISTRY targets only; keep empty for non-schema-registry targets

Response

Successfully retrieved table mapping details

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.