Get Ontology

GET/api/v2/ontologies/{ontology}

Gets a specific ontology for a given Ontology API name or RID.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:ontologies-read.

Path parameters

ontology

string

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

Response body

OntologyV2

object

Success response.

Hide child attributes

apiName

string

displayName

string

The display name of the entity.

description

string

rid

string

The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/ontologies/palantir"

Response

Copied!

{
  "apiName": "default-ontology",
  "displayName": "Ontology",
  "description": "The default ontology",
  "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"
}