Gets a specific object 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 object type. To find the API name, use the List object types endpoint or check the Ontology Manager.
stringoptionalThe Foundry branch to load the object type definition from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.
booleanoptionalWhen set to true, the datasources field on the returned object type is populated with the
datasources backing it. Defaults to false.
objectSuccess response.
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, ENDORSED, EXPERIMENTAL, DEPRECATED
stringoptionalThe 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).
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>optionalA map of the properties of the object type.
stringThe 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)optionalThe suggested visibility of the object type.
Enum values: NORMAL, PROMINENT, HIDDEN
list<string>optionalAlternative names (synonyms) for the object type, usable as search terms. This field is only populated on
the get-by-RID read paths (e.g. getObjectTypeV2); it is always empty on the listObjectTypesV2 endpoint.
list<ObjectTypeDatasource>optionalThe datasources backing this object type which the user has access to see. Only populated when the request
specifies includeDatasources=true. This list may be empty if the user doesn't have access to any
datasources.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/objectTypes/employee?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"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
{
"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.0381eda6-69bb-4cb7-8ba0-c6158e094a04"
}