Skip to content

@oneplatform/plugin-sdk


@oneplatform/plugin-sdk / OntologyAccessor

Interface: OntologyAccessor

Defined in: packages/plugin-sdk/src/types/context.ts:176

Methods

getEntitySchema()

getEntitySchema(entityType): Promise\<EntitySchema | null>

Defined in: packages/plugin-sdk/src/types/context.ts:191

Retrieve the schema for a single entity type by name. Returns null if the entity type does not exist in this tenant's ontology.

Parameters

entityType

string

Returns

Promise\<EntitySchema | null>


getSchema()

getSchema(): Promise\<OntologySchema>

Defined in: packages/plugin-sdk/src/types/context.ts:185

Read-only access to the tenant's current ontology schema. Returns all entity type definitions currently configured for this tenant. Result is cached within a single execution — repeated calls do not make additional network requests.

Plugins CANNOT mutate the ontology. This method is read-only.

Returns

Promise\<OntologySchema>