Version 2.0

Get Object Type Full Metadata

GET/api/v2/ontologies/{ontology}/objectTypes/{objectType}/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.

Gets the full metadata for a specific object type with the given API name.

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.

objectType

string

The API name of the object type. To find the API name, use the List object types endpoint or check the Ontology Manager.

Query parameters

preview

booleanoptional

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

sdkPackageRid

stringoptional

The package rid of the generated SDK.

sdkVersion

stringoptional

The version of the generated SDK.

branch

stringoptional

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

Response body

ObjectTypeFullMetadata

object

Success response.

Hide child attributes

objectType

object

Represents an object type in the Ontology.

Show child attributes

linkTypes

list<LinkTypeSideV2>optional

Show child attributes

implementsInterfaces

list<InterfaceTypeApiName>optional

A list of interfaces that this object type implements.

Show child attributes

implementsInterfaces2

map<InterfaceTypeApiName, ObjectTypeInterfaceImplementation>optional

A list of interfaces that this object type implements and how it implements them.

Show child attributes

sharedPropertyTypeMapping

map<SharedPropertyTypeApiName, PropertyApiName>optional

A map from shared property type API name to backing local property API name for the shared property types present on this object type.

Show child attributes

Examples

Request

Copied!

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