Read (GET) a List Item

Use this API to read a single list item by specifying the code table and code. In DPS, the Labels and Lists section includes global labels and lists options. Lists contain values to populate drop-down lists used throughout the product. These lists save time during routine entry and enforce uniformity in data fields.

To read a list item:

Execute a GET command on the endpoint {{url}}/codeTable/<codetable>/code, where the codetable variable is the name of the list you want to read and code is the value of the list item you want to retrieve.

For example, here is a request, using cURL, to get a specific job title for an employee by setting the codetable variable to CFGEmployeeTitle and setting the list item variable code to Architect. For a list of code table values, see GUID-9B82635D-5ED2-41EA-8FA1-C2882CFC3561.

curl --request GET \
  --url 'https://{{url}}/codeTable/CFGEmployeeTitle/Architect' \
  --header 'authorization: Bearer {{oauth_token}}' \
  --header 'content-type: application/json'

The call returns the JSON representation of the list item, for example:

[
    {
        "Code": "Architect",
        "Description": "Architect",
        "Seq": 4
    }
]