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.
Gets a specific value type with the given API name.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.
stringThe API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or check the Ontology Manager.
stringThe API name of the value type. To find the API name, use the List value types endpoint or check the Ontology Manager.
booleanA boolean flag that, when set to true, enables the use of beta features in preview mode.
objectSuccess response.
stringThe name of the value type in the API in camelCase format.
stringThe display name of the entity.
stringstringstring (enum)Enum values: ACTIVE, DEPRECATED
unionstringlist<ValueTypeConstraint>1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/valueTypes/countryCode?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"apiName": "countryInitials",
"description": "A three letter code for a top-level administrative region",
"displayName": "Country Initials",
"status": "ACTIVE",
"fieldType": "string",
"rid": "ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d",
"constraints": [
{
"type": "length",
"length": {
"minimumLength": 3,
"maximumLength": 3
}
}
]
}