Mappings Request and Response Body Schemas

Request Body (XML)

(POST method)

<mappings>
    <policy qualificationTolerance="Low|Normal|High" dataTypeTolerance="Low|Normal|High">
        <strategies mappingSourceIds="string">
            <strategy name="SameId|SameName|SameTechnicalName|SamePath|CloseName|Selection|Removal" targetId="string" />
    <content>
        <mapping>
            <source>
                <id>
            <target>
                <id>
    <parameters>

Element

Description

<policy>

Attributes:
  • qualificationTolerance (Low|Normal|High)
  • dataTypeTolerance (Low|Normal|High)
They specify the tolerance to be considered when matching the source and target datasource objects. They define the compatibility rules.

<strategies>

The list of strategies to apply. This element is optional.

Attribute: mappingSourceIds to apply the strategies to the specified source data objects. The IDs are separated by a comma. If no attribute is specified, the strategy will apply to all source data objects (default strategy).

<strategy>

A strategy selected to compute the possible object mappings.

Attributes:

  • name: strategy name
  • targetId required by the Selection strategy to specify the ID of the target data object to be selected

<content>

The custom object mapping. This element is optional.

<parameters>

The document prompt answers if necessary. This element is optional.

The following table describes the qualificationTolerance attribute values:

Attribute value Description
Low The source and target data objects must have the same qualification.
Normal The source and target data objects can have close qualifications.
High The source and target data objects can have different qualifications.

The following table describes the dataTypeTolerance attribute values:

Attribute value Description
Low The source and target data objects must have the same data type.
Normal The source and target data objects can have close data types.
High The source and target data objects can have different data types.

Example

qualificationTolerance="Low" dataTypeTolerance="High" means:
  • The qualifications of the source and target data objects must be exactly the same.

  • The data types of the source and target data objects can be different.

Response Body (XML)

(GET and POST methods)

<mappings>
    <content>
        <mapping status="Ok|Ambiguous|Not found">
            <source>
                <id>
            <target>
                <id>
Element Type or Value Description
<mapping> N/A Attribute: status
  • Ok if the mapping fully matches
  • Ambiguous in case of uncertain mapping
  • Not found if there is no possible match
    Note The Not found status removes the corresponding ID from the document when doing the data source change.
source <id> string The identifier of the source data object
target <id> string The identifier of the target data object