This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Gets a specific interface 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 interface type. To find the API name, use the List interface types endpoint or check the Ontology Manager.
booleanA boolean flag that, when set to true, enables the use of beta features in preview mode.
stringThe Foundry branch to load the interface type definition from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.
objectSuccess response.
stringThe unique resource identifier of an interface, useful for interacting with other Foundry APIs.
stringThe name of the interface type in the API in UpperCamelCase format. To find the API name for your interface
type, use the List interface types endpoint or check the Ontology Manager.
stringThe display name of the entity.
stringThe description of the interface.
map<SharedPropertyTypeApiName, InterfaceSharedPropertyType>A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties.
map<SharedPropertyTypeApiName, InterfaceSharedPropertyType>A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has, including properties from all directly and indirectly extended interfaces.
list<InterfaceTypeApiName>A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties.
list<InterfaceTypeApiName>A list of interface API names that this interface extends, both directly and indirectly.
list<ObjectTypeApiName>A list of object API names that implement this interface.
map<InterfaceLinkTypeApiName, InterfaceLinkType>A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has.
map<InterfaceLinkTypeApiName, InterfaceLinkType>A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has, including links from all directly and indirectly extended interfaces.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/ontologies/palantir/interfaceTypes/Employee?preview=true&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
{
"apiName": "Athlete",
"displayName": "Athlete",
"description": "Good at sportsball",
"properties": {
"name": {
"rid": "com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b",
"apiName": "name",
"displayName": "Name",
"dataType": "string"
}
},
"extendsInterfaces": [
"Human"
],
"rid": "ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"
}