Reverse Transcoding

Learn more about how to use the Transcode API to return a canonical lookup value in the representation expected by a target source system.

The Transcode supports reverse transcoding. Reverse transcoding takes a canonical lookup code or value and returns the matching code and value used by a target source system.

Reverse transcoding is useful when a downstream system expects its own code or value instead of the canonical value.

To return a localized canonical value, set the Accept-Language header in the request.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

POST https://{{rdm-service}}/transcode/rdm_tenant_name/value?targetSource=AHA

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`rdm_tenant_name`	String	Yes	Name of the RDM tenant that processes the request. RDM resolves the value against the reference data configured in this tenant.

Query parameters

The following table describes the query parameters and their values.


Parameter	Type	Required	Description	Accepted values / Default
`targetSource`	String	No	Source system whose value RDM returns for the canonical value. If you omit this parameter or pass a source that does not exist, RDM returns the canonical value instead of a source-specific value.	Example: `AHA`

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	`Bearer <token>`	Yes
`Content-Type`	`application/json`	Yes
`Accept-Language`	`Locale value`	No

Request body

The following table describes the request body parameters, including accepted values and defaults.


Parameter	Type	Required	Description	Accepted values / Default
`type`	String	Yes	URI of the lookup type to resolve.	Example: `rdm/lookupTypes/Country`
`value`	String	Yes	Canonical lookup code or canonical value to reverse transcode.	Example: `US`
`source`	String	Yes	Source system associated with the input value.	Source URI, such as `rdm/sources/Reltio`, or source name, such as `Reltio`

Example request

The following request includes targetSource set to AHA. RDM reverse transcodes the canonical country code US from Reltio to AHA. The request source is Reltio, the source of the input value.

POST {{rdm_uri}}/transcode/{{rdm_tenant}}/value?targetSource=AHA
{
  "type": "rdm/lookupTypes/Country",
  "value": "US",
  "source": "rdm/sources/Reltio"
}

The following request omits targetSource. RDM reverse transcodes the canonical country code US from Reltio. The request source is Reltio, the source of the input value.

POST {{rdm_uri}}/transcode/{{rdm_tenant}}/value
{
  "type": "rdm/lookupTypes/Country",
  "value": "US",
  "source": "rdm/sources/Reltio"
}

Response body

The following table describes the fields returned in the response body.


Parameter	Type	Description
`type`	String	Lookup type URI that RDM resolved.
`code`	String	Code of the resolved value in the target source representation.
`value`	String	Resolved value returned for the target source system.
`source`	String	Source system URI associated with the input value.
`success`	Boolean	Whether reverse transcoding completed successfully. The value is `true` when it succeeds and `false` when it fails.

Example response

The following example shows a successful response where RDM returns AHA code 080 and value USA.

{
  "type": "rdm/lookupTypes/Country",
  "code": "080",
  "value": "USA",
  "source": "rdm/sources/AHA",
  "success": true
}