List Lookups by Type

Returns a list of lookups by specified type.

Request:

POST {TenantURL}/lookups/list

Table 1. Parameters
Name		Required	Description
Headers	`Content-Type`	Yes	Should be " `Content - Type: application/json`".
Headers	`Body`	Yes	JSON object with the lookup type.

Table 2. Optional Parameters
Parameter	Type	Default	Description
`parents`	array	-	An array of lookup URIs used to filter lookups based on their parent relationships. Each URI in the array follows the format: `rdm/lookupTypes/{{lookupType}}/{{lookupCode}}` type - type of a particular parent. codeValues - applicable values for parents (if lookup has at least one parent of provided type with provided value then we will return it)
`type`	string	-	The target lookup type to list.
`max`	integer	-	Maximum number of lookups in a response.
`offset`	Integer	`0`	Starting index for lookup values in a paginated response.
`displayNamePrefix`	string	-	Lookups display name prefix for filtering. Lookup values whose display name start with this value will be returned.
`sortByDisplayName`	Boolean	`false`	Sorting by `displayName` field.
`sortOrder`	String	`"asc"`	Sort order for lookup values when `sortByDisplayName` is enabled. Possible values: `asc`, `desc`.

Request Example

{
  "displayNamePrefix":"US",
  "max":51,
  "offset":0,
  "parents":[
    {
        "type":"rdm/lookupTypes/Country",
        "codeValues":[
            "USA1"
        ]
    }
  ],
  "sortByDisplayName":true,
  "sortOrder":"asc",
  "type":"rdm/lookupTypes/Country"
}

Response Example

{
    "parents": [
        {
            "type": "rdm/lookupTypes/Country",
            "codeValues": [
                "USA1"
            ]
        }
    ],
    "codeValues": {
        "rdm/lookupTypes/Country": {
            "USA": {
                "displayName": "US",
                "parents": [
                    "rdm/lookupTypes/Country/USA1"
                ]
            }
        }
    }
}

Unify and manage your data

List Lookups by Type

Footer