Search documentation
karat

+

K

User Documentation ↗

List Object Types

GET/api/v2/ontologies/{ontology}/objectTypes

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.

Path parameters

ontology
string

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

Query parameters

pageSize
integer
optional

The desired size of the page to be returned. Defaults to 500. See page sizes for details.

pageToken
string
optional

The 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.

Response body

ListObjectTypesV2Response
object

Success response.

Hide child attributes

Hide child attributes

nextPageToken
string
optional

The 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.

data
list<ObjectTypeV2>
optional

The list of object types in the current page.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/objectTypes"

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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 { "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z", "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" }, "rid": "ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996" }, "fullName": { "dataType": { "type": "string" }, "rid": "ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1" }, "office": { "description": "The unique ID of the employee's primary assigned office", "dataType": { "type": "string" }, "rid": "ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633" }, "startDate": { "description": "The date the employee was hired (most recently, if they were re-hired)", "dataType": { "type": "date" }, "rid": "ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4" }, "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" } } ] }