Getting the Possible Object Mappings Using the Default Strategies

Usage

Gets the list of possible object mappings that have been found using the default strategies.

If no data provider is specified, the request is run for all the existing data providers in the document.

Request

GET /documents/<documentID>/dataproviders/mappings?originDataproviderIds=<dataProviderID[,...]>&targetDatasourceId=<dataSourceID>

Where:

  • <dataProviderID[,...]> is the list of data provider identifiers to consider for the mapping, separated by commas. This parameter is optional.
  • <dataSourceID> is the target data source identifier to use for the proposal mapping. This parameter is mandatory.
Response

Response type: application/xml or application/json

Response body: the details of the mappings, described in Mappings Request and Response Body Schemas.

Example

To Get the Possible Mappings

Data provider IDs are DP0 and DP1. Target data source ID is 11414.

GET /documents/9460/dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=11414

<mappings>
    <content>
        <mapping status="Ok">
            <source>
                <id>DS0.DO12</id>
            </source>
            <target>
                <id>DS1.DO12</id>
            </target>
        </mapping>
        <mapping status="Ok">
            <source>
                <id>DS0.DO13</id>
            </source>
            <target>
                <id>DS1.DO13</id>
            </target>
        </mapping>
        ...      
        <mapping status="Ok">
            <source>
                <id>DS0.DO7</id>
            </source>
            <target>
                <id>DS1.DO7</id>
            </target>
        </mapping>
        <mapping status="Ambiguous">
            <source>
                <id>DS0.DO84</id>
            </source>
            <target>
                <id>DS1.DO6</id>
            </target>
        </mapping>
    </content>
</mappings>

Example

To Get the Possible Mappings When the Target is a BEx Query

Data provider IDs are DP0 and DP1. Target data source ID is "10326;AAQUERY_RESTRICT_KF".

GET /documents/10554/dataproviders/mappings?originDataproviderIds=DP0,DP1&targetDatasourceId=10326;AAQUERY_RESTRICT_KF

<mappings>
    <content>
        <mapping status="Ok">
            <source>
                <id>AZ_CITY</id>
            </source>
            <target>
                <id>AZ_CITY</id>
            </target>
        </mapping>
        <mapping status="Ambiguous">
            <source>
                <id>MA55OT46EO4K803Z77TO03LNMU</id>
            </source>
            <target>
                <id>MD4NTN2159JU9ONUUHTLMNBW3U</id>
            </target>
        </mapping>
    </content>
</mappings>