Interface: DocumentProfile

Defined in: domain/contracts.ts:172

A document profile: a JSON Schema plus derived field metadata that defines one kind of document.

Properties

description?

description?: string | LocalizedString;

Defined in: domain/contracts.ts:176

---

fields

fields: Record<string, FieldDescriptor>;

Defined in: domain/contracts.ts:180

---

id

id: string;

Defined in: domain/contracts.ts:173

---

label?

label?: string | LocalizedString;

Defined in: domain/contracts.ts:175

---

multilingual?

multilingual?: boolean;

Defined in: domain/contracts.ts:181

---

optionalFreeText?

optionalFreeText?: boolean;

Defined in: domain/contracts.ts:182

---

schema

schema: object;

Defined in: domain/contracts.ts:178

---

schemaId

schemaId: string;

Defined in: domain/contracts.ts:177

---

typeLibraryVersion

typeLibraryVersion: string;

Defined in: domain/contracts.ts:179

---

version

version: string;

Defined in: domain/contracts.ts:174