Reference 360

Back Next

Get code value details (v2)

Retrieves the details of a code value in a code list based on the internal ID or alias of the code list.

GET request

To retrieve the details of a code value, submit a GET request with the following URI and specify the code:

/rdm-service/external/v2/codelists/{codeListKey}/codevalues?Code={code}

The following table describes the parameter in the request body:

Parameter	Type	Description
codeListKey	String	Internal ID or alias of the code list that contains the code value.
Code	String	The code field for the code value.

GET response

The response contains the details of the code value.

The following table describes the attributes in the response body:

Field	Type	Description
codelistId	String	ID of the code list that contains the code value.
internalId	String	Internal ID of the code list that contains the code value.
alias	String	Alias of the code list that contains the code value.
businessId		Business ID of the code value.
codeValueFields	Array	Lists the attribute field values for the code value.
Code	String	The code field for the code value.
Name	String	The name field for the code value.

GET example

To retrieve the first page of code values in a code list based on its internal ID

country

, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues?Code=CODE-A HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the details of a code value:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 237

[
  {
    "codelistId": "67e2590c022698651e1964c8",
    "internalId": "code1",
    "alias": "alias1",
    "businessId": "RDM0000123",
    "codeValueFields": {
      "Code": "CODE-A",
      "Name": "NAME-A"
    }
  }
]

codelists version 2

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal