Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Ontology Value Types

GET/api/v2/ontologies/{ontology}/valueTypes
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Lists the latest versions of the value types for the given Ontology.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontology
string

The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.

Query parameters

preview
boolean
optional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

ListOntologyValueTypesResponse
object

Success response.

Hide child attributes

Hide child attributes

data
list<OntologyValueType>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/valueTypes?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 { "data": [ { "apiName": "validNorthAmericanCountries", "description": "Options for valid countries in North America", "displayName": "Valid North American Countries", "status": "ACTIVE", "fieldType": "string", "rid": "ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d", "constraints": [ { "type": "enum", "enum": { "options": [ "USA", "Mexico", "Canada" ] } } ] }, { "apiName": "countyCode", "description": "A three letter code for a US County.", "displayName": "County Code", "status": "ACTIVE", "fieldType": "string", "rid": "ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c8232", "constraints": [ { "type": "length", "length": { "minimumLength": 3, "maximumLength": 3 } } ] } ] }