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 unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please 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.
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, EXPERIMENTAL, DEPRECATED
stringThe description of the object type.
string (enum)The suggested visibility of the object type.
Enum values: NORMAL, PROMINENT, HIDDEN
list<PropertyApiName>The primary key of the object. This is a list of properties that can be used to uniquely identify the object.
map<PropertyApiName, Property>A map of the properties of the object type.
stringThe unique resource identifier of an object type, useful for interacting with other Foundry APIs.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/objectTypes/employee"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"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.0381eda6-69bb-4cb7-8ba0-c6158e094a04"
}