API Reference

Get Ontology

GET/api/v1/ontologies/{ontologyRid}

Gets a specific ontology with the given Ontology RID.

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

Path parameters

ontologyRid

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.

Response body

Ontology

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 \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"

Response

Copied!

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