Reference 360

Back Next

Get code value details

Retrieves the details of a code value.

You identify the code value that you want to retrieve the details for by specifying the value in the Code attribute.

You cannot use the + symbol inside the code field value.

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/v1/codelists/{code list ID}/codevalues?Code={code}

GET response

The response contains the details of the code value.

The following table describes the attributes in the response:

Field	Type	Description
codelistId	String	ID of the code list that the code values belong to.
status	String	Optional. Status of the code value. To retrieve a list of statuses, use the List enum entries API. For more information, see Get system reference data values.
effectiveDate	String	Optional. Date the code value became effective.
codeValueFields	Object	Includes the attribute field values for the code value.

GET example

To retrieve the details of a code value, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/591c302d8af18b0001b1fac2/codevalues?Code=AR 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":"591c302d8af18b0001b1fac2",
    "status":"Draft",
    "effectiveDate":"2019-09-20",
    "codeValueFields":{ 
      "Name":"Argentina",
      "Code":"AR",
      "description":"The EU country code for Argentina"
    }
  }
]

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get code value details

Get code value details

GET request

GET response

GET example