Reference 360

Back Next

Search code values

Use the search API to search for code values in all the code lists.

POST request

To search for code values in all the code lists, submit a POST request with the following URI:

/rdm-service/external/v1/search

Use the following parameters in the search request body:

Field	Type	Description
page	Integer	Optional. Page number to display. Default is 0.
pageSize	Integer	Optional. Number of code values that you want to display on each page. Default is 100. You can specify up to 10000.
search	String	Search string that must contain a minimum of two characters. For example, you can specify the search string as "IND." You can use only the values of string data type attributes, such as name, code, description, and other custom string attributes. You can't use the values of integer, date, boolean, and decimal data type attributes in the search string. To retrieve all the code values, use an asterisk (*). To retrieve the exact code value that you search for, specify the search string in the following format: "\"<search_string>\"" For example, to search for the exact code value AUSTRIA , specify "\"AUSTRIA\"" as search string.

POST response

The request response returns the search results.

The response contains the following attributes:

Field	Type	Description
pageSize	Integer	Number of code values displayed on each page.
page	Integer	Number of the page that you retrieved.
totalNumberOfElements	Integer	Total number of code values found.
numberOfElements	Integer	Total number of code values on the current page.
lastPage	Boolean	Indicates whether the current page is the last page of the search results.
firstPage	Boolean	Indicates whether the current page is the first page of the search results.
referenceDataSetId	String	Unique identifier of the reference data set that the code value belongs to.
referenceDataSetName	String	Name of the reference data set that the code value belongs to.
codeListId	String	Unique identifier of the code list that the code value belongs to.
codeListName	String	Name of the code list that the code value belongs to.

POST example

To search for code values in all the code lists, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/search HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
{
   "page":1,
   "pageSize":1,
   "search":"IN"

The following sample response displays the code values that contain IN in all the code lists:

{
   "pageSize":1,
   "page":1,
   "totalNumberOfElements":20,
   "numberOfElements":1,
   "lastPage":false,
   "firstPage":false,
   "content":[
      {
         "record":{
            "Name":"INDIA",
            "Code":"IN",
            "Description":"Desc-India"
         },
         "referenceDataSetId":"65603a826052154799cd87b1",
         "referenceDataSetName":"Country",
         "codeListId":"65603a836052154799cd87c2",
         "codeListName":"Enterprise Country"
      }
   ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Search code values

Search code values

POST request

POST response

POST example