Lists the object types for the given Ontology.
Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.
stringThe API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
integerThe desired size of the page to be returned. Defaults to 500. See page sizes for details.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
objectSuccess response.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
list<ObjectTypeV2>The list of object types in the current page.
objectRepresents an object type in the Ontology.
stringThe name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
List object types endpoint or check the Ontology Manager.
stringThe display name of the entity.
string (enum)The release status of the entity.
Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED
stringThe description of the object type.
stringThe plural display name of the object type.
unionA union currently only consisting of the BlueprintIcon (more icon types may be added in the future).
objectstringA hexadecimal color code.
stringThe name of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
map<PropertyApiName, PropertyV2>A map of the properties of the object type.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
objectDetails about some property of an object.
stringstringThe display name of the entity.
unionA union of all the types supported by Ontology Object properties.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectunionA union of the types supported by time series properties.
objectobjectobjectunionA union of all the types supported by Ontology Object properties.
objectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectobjectunionA union of the types supported by time series properties.
objectobjectobjectunionA union of all the types supported by Ontology Object properties.
objectobjectintegerintegerobjectobjectobjectintegerintegerobjectstringThe unique resource identifier of an object type, useful for interacting with other Foundry APIs.
stringThe name of the property in the API. To find the API name for your property, use the Get object type
endpoint or check the Ontology Manager.
string (enum)The suggested visibility of the object type.
Enum values: NORMAL, PROMINENT, HIDDEN
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objectTypes?pageSize=&pageToken="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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
"nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv",
"data": [
{
"apiName": "employee",
"description": "A full-time or part-time employee of our firm",
"displayName": "Employee",
"status": "ACTIVE",
"primaryKey": "employeeId",
"properties": {
"employeeId": {
"dataType": {
"type": "integer"
}
},
"fullName": {
"dataType": {
"type": "string"
}
},
"office": {
"description": "The unique ID of the employee's primary assigned office",
"dataType": {
"type": "string"
}
},
"startDate": {
"description": "The date the employee was hired (most recently, if they were re-hired)",
"dataType": {
"type": "date"
}
},
"rid": "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"
}
},
{
"apiName": "office",
"description": "A physical location (not including rented co-working spaces)",
"displayName": "Office",
"status": "ACTIVE",
"primaryKey": "officeId",
"properties": {
"officeId": {
"dataType": {
"type": "string"
}
},
"address": {
"description": "The office's physical address (not necessarily shipping address)",
"dataType": {
"type": "string"
}
},
"capacity": {
"description": "The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)",
"dataType": {
"type": "integer"
}
},
"rid": "ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"
}
}
]
}