Transcode Simple Lookup

Learn more about how to use the Transcode API to resolve a single source lookup value to its canonical value.

The Transcode for simple lookup resolves a value independently within a single lookup type, without depending on a parent lookup value. This operation applies when the source value contains enough information to map to a canonical value.

When you send a transcode request, provide the lookup type, value, and source system. RDM checks the value in the following order and stops at the first successful match:

RDM checks whether the value matches a source mapping code in the specified source system.
If no code matches, it checks whether the value matches a source mapping value in the same source system.
If neither matches, it checks whether the value matches a canonical code.

To return the resolved values in a specific language, 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

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`rdm_tenant_name`	String	Yes	The unique name of the RDM tenant in which the request is processed.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	`Bearer <token>`	Yes
`Content-Type`	`application/json`	Yes
`Accept-Language`	Language code, such as `es-ES`	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/State`
`value`	String	Yes	Source value to transcode.	Example: `AR`
`source`	String	Yes	URI of the source system for the input value.	Source URI, such as `rdm/sources/Reltio`, or source name, such as `Reltio`

Example request

Use the following example to see how a complete request is structured with headers and a JSON body.

POST https://{{rdm-service}}/transcode/rdm_tenant_name
[
    {
        "values": {
            "rdm/lookupTypes/State": [
                {
                    "type": "rdm/lookupTypes/State",
                    "value": "AR",
                    "source": "rdm/sources/Reltio"
                }
            ]
        }
    }
]

Response body

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


Field	Type	Description
`type`	String	Lookup type URI resolved by the request.
`code`	String	Canonical code associated with the resolved value.
`value`	String	Canonical value returned for the source value.
`source`	String	Source system URI associated with the input value.
`success`	Boolean	Indicates whether the transcode operation completed successfully.
`attributes`	Array	Custom attributes defined for the resolved lookup value. Each item includes `name` and `value`. RDM returns this field when attributes are defined for the lookup.

Example response

The following example shows a successful response.

[
    {
        "values": {
            "rdm/lookupTypes/State": [
                {
                    "type": "rdm/lookupTypes/State",
                    "code": "AR",
                    "value": "Arkansas",
                    "source": "rdm/sources/Reltio",
                    "success": true
                }
            ]
        }
    }
]

Error codes and recommended actions

The following table lists the possible error responses returned by the operation.


HTTP status	Description	Recommended action
`404 Not Found`	The submitted value was not found in the specified source.	Verify the lookup type, value, and source, then resend the request.

Unify and manage your data