Get Ontology Full Metadata

GET/api/v2/ontologies/{ontology}/fullMetadata

Warning

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.

Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.

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

Path parameters

ontology

string

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

OntologyFullMetadata

object

Success response.

ontology

object

Metadata about an Ontology.

objectTypes

map<ObjectTypeApiName, ObjectTypeFullMetadata>

optional

actionTypes

map<ActionTypeApiName, ActionTypeV2>

optional

queryTypes

map<QueryApiName, QueryTypeV2>

optional

interfaceTypes

map<InterfaceTypeApiName, InterfaceType>

optional

sharedPropertyTypes

map<SharedPropertyTypeApiName, SharedPropertyType>

optional

Copied!

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