knowmax-quest-types/dist/types/IMetadata.d.ts

Contains type definitions for communicating with Knowmax Quest.

export interface IMetadata {
    familyLabel: string;
    /** Label for Knowmax Octa domain to which defintion is connected. */
    octaDomainLabel?: string;
    label: string;
    value: string;
    dataTypeHint?: string;
    description?: string;
    /** Origin of value. Possible values: Document, DocumentVersion, DocumentNode, Dynamic, DynamicIndexable, Collection */
    origin?: string;
    /** If set this value can't be changed. Only set for metadata of documentversion(nodes). Metadata of document and collections is always mutable. */
    immutable?: boolean;
    /** Label for this value in a Knowmax Octa domain. Only used when the metadata definition is linked to a Knowmax Octa domain. */
    octaDomainValueLabel?: string;
    modified?: string;
    modifiedBy?: string;
    created?: string;
    createdBy?: string;
}
/** Variant of IMetadata suitable for patch operations. Value field is nullable in order to delete values in patch operation. */
export type IMetadataPatchable = Omit<IMetadata, 'value'> & {
    value?: IMetadata['value'];
};
//# sourceMappingURL=IMetadata.d.ts.map