Reference 360

Back Next

Search code values (v2)

Use the search API to search for code values in all the code lists based on the internal ID or alias.

POST request

To search for code values in all the code lists based on an internal ID or alias, submit a POST request with the following URI:

/rdm-service/external/v2/search

Use the following parameters in the search request:

Field	Type	Description
showAssetDetails	Boolean	Indicates whether the search result displays the details of assets. Value can be true or false . Default is false .
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 in the response body:

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.
content	Object	Includes the list of code values.
record	Array	Includes the details of the code value.
Name	String	Name of the code value.
Code	String	Code field value of the code value.
referenceDataSetDetails	Array	Includes details of the reference data set.
id	String	ID of the reference data set. For more information, see Asset IDs.
name	String	Name of the reference data set.
internalId	String	Unique identifier of the reference data set.
alias	String	Alternative identifier of the reference data set.
codeListDetails	Array	Includes details of the code list.
id	String	ID of the code list. For more information, see Asset IDs.
name	String	Name of the code list.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.

POST example

To search for code values in all the code lists based on the internal ID or alias, you might use the following request:

POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/search?showAssetDetails=true' 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": 0,
  "totalNumberOfElements": 20,
  "numberOfElements": 1,
  "lastPage": false,
  "firstPage": true,
  "content": [
    {
      "record": {
        "Description": "Desc-India",
        "Name": "INDIA",
        "Code": "IN"
      },
      "referenceDataSetDetails": {
        "id": "65603a826052154799cd87b1",
        "name": "Country",
        "internalId": "country",
        "alias": "als_country"
      },
      "codeListDetails": {
        "id": "65603a836052154799cd87c2",
        "name": "Enterprise Country",
        "internalId": "ent_country",
        "alias": "als_ent_country"
      }
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Search code values (v2)

Search code values (v2)

POST request

POST response

POST example