Interface: OntologyExportOptions

@kortexya/reasoninglayer / OntologyExport / OntologyExportOptions

Interface: OntologyExportOptions

Defined in: src/types/ontology-export.ts:61

Options for an ontology export.

Remarks

base and root are query parameters; format selects the Accept header. Omitting root exports the whole tenant schema.

root is repeatable: pass an array to select several sub-lattices in one export. It is serialized as a repeated parameter (?root=a&root=b), which is what the backend parses.

Example

const options: OntologyExportOptions = {
  base: 'https://example.org/ontology#',
  root: 'clinical_entity',
  format: 'turtle',
};

// Several sub-lattices in one export
const multi: OntologyExportOptions = {
  root: ['clinical_entity', 'administrative_entity'],
  format: 'turtle',
};

Properties

base?

optional base: string

Defined in: src/types/ontology-export.ts:66

Base IRI for synthesized IRIs (defaults server-side to urn:osfkb:tenant:{tenant_id}).

format?

optional format: OntologyExportFormat

Defined in: src/types/ontology-export.ts:71

The serialization to request.

Default Value

'json'

root?

optional root: string | string[]

Defined in: src/types/ontology-export.ts:81

Restrict the export to the sub-lattice under this sort, or — given an array — to the union of the sub-lattices under each of these sorts. Omit to export the whole tenant schema.

Remarks

Serialized as a repeated query parameter (?root=a&root=b). Every named sort must exist: the backend 404s on the first unknown name.