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 populate the next request's pageToken field with it.

Response body

ListObjectTypesV2Response
object

Success response.

Hide children

Hide children

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 populate the next request's pageToken field with it.

data
list<ObjectTypeV2>
optional

The list of object types in the current page.

Show children

Show children

ObjectTypeV2
object

Represents an object type in the Ontology.

Show children

Show children

apiName
string

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

displayName
string

The display name of the entity.

status
string (enum)

The release status of the entity.

Enum values: ACTIVE, EXPERIMENTAL, DEPRECATED

description
string
optional

The description of the object type.

pluralDisplayName
string

The plural display name of the object type.

icon
union

A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).

Show children

Show children

blueprint
object
optional
Show children

Show children

color
string

A hexadecimal color code.

name
string

The name of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app.

primaryKey
string

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

properties
map<PropertyApiName, PropertyV2>
optional

A map of the properties of the object type.

Show children

Show children

PropertyApiName
string

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

PropertyV2
object

Details about some property of an object.

Show children

Show children

description
string
optional
displayName
string
optional

The display name of the entity.

dataType
union

A union of all the types supported by Ontology Object properties.

Show children

Show children

date
object
optional
string
object
optional
byte
object
optional
double
object
optional
geopoint
object
optional
geotimeSeriesReference
object
optional
integer
object
optional
float
object
optional
geoshape
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
attachment
object
optional
timeseries
object
optional
Show children

Show children

itemType
union

A union of the types supported by time series properties.

Show children

Show children

string
object
optional
double
object
optional
array
object
optional
Show children

Show children

subType
union

A union of all the types supported by Ontology Object properties.

Show children

Show children

date
object
optional
string
object
optional
byte
object
optional
double
object
optional
geopoint
object
optional
geotimeSeriesReference
object
optional
integer
object
optional
float
object
optional
geoshape
object
optional
long
object
optional
boolean
object
optional
marking
object
optional
attachment
object
optional
timeseries
object
optional
Show children

Show children

itemType
union

A union of the types supported by time series properties.

Show children

Show children

string
object
optional
double
object
optional
array
object
optional
Show children

Show children

subType
union

A union of all the types supported by Ontology Object properties.

short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
timestamp
object
optional
short
object
optional
decimal
object
optional
Show children

Show children

precision
integer
optional
scale
integer
optional
timestamp
object
optional
rid
string

The unique resource identifier of an object type, useful for interacting with other Foundry APIs.

titleProperty
string

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

visibility
string (enum)
optional

The suggested visibility of the object type.

Enum values: NORMAL, PROMINENT, HIDDEN

Examples

Request

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

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 { "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" } } ] }