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 unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please 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 use it to populate the pageToken field of the next request.
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 use it to populate the pageToken field of the next request.
list<ObjectType>The list of object types in the current page.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes"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
{
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
"data": [
{
"apiName": "employee",
"description": "A full-time or part-time employee of our firm",
"primaryKey": [
"employeeId"
],
"properties": {
"employeeId": {
"baseType": "Integer"
},
"fullName": {
"baseType": "String"
},
"office": {
"description": "The unique ID of the employee's primary assigned office",
"baseType": "String"
},
"startDate": {
"description": "The date the employee was hired (most recently, if they were re-hired)",
"baseType": "Date"
}
},
"rid": "ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"
},
{
"apiName": "office",
"description": "A physical location (not including rented co-working spaces)",
"primaryKey": [
"officeId"
],
"properties": {
"officeId": {
"baseType": "String"
},
"address": {
"description": "The office's physical address (not necessarily shipping address)",
"baseType": "String"
},
"capacity": {
"description": "The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)",
"baseType": "Integer"
}
},
"rid": "ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"
}
]
}