API Reference
Search documentation
karat

+

K

User Documentation ↗
Version 2.0

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. This endpoint is designed to return as much metadata as possible in a single request to support OSDK workflows. It may omit certain entities rather than fail the request.

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.

Query parameters

branch
stringoptional

The Foundry branch to load metadata from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.

preview
booleanoptional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

OntologyFullMetadata
object

Success response.

Hide child attributes

Hide child attributes

ontology
object

Metadata about an Ontology.

Show child attributes

Show child attributes

objectTypes
map<ObjectTypeApiName, ObjectTypeFullMetadata>optional
Show child attributes

Show child attributes

actionTypes
map<ActionTypeApiName, ActionTypeV2>optional
Show child attributes

Show child attributes

queryTypes
map<VersionedQueryTypeApiName, QueryTypeV2>optional
Show child attributes

Show child attributes

interfaceTypes
map<InterfaceTypeApiName, InterfaceType>optional
Show child attributes

Show child attributes

sharedPropertyTypes
map<SharedPropertyTypeApiName, SharedPropertyType>optional
Show child attributes

Show child attributes

branch
objectoptional

Metadata about a Foundry branch.

Show child attributes

Show child attributes

valueTypes
map<ValueTypeApiName, OntologyValueType>optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/ontologies/palantir/fullMetadata?branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252&preview=true"