Interface DataSchema

interface DataSchema {
    title?: string;
    description?: string;
    type?: string | string[];
    format?: string;
    properties?: {
        [key: string]: DataSchema;
    };
    items?: DataSchema;
    additionalProperties?: boolean | DataSchema;
    enum?: string[];
    referenceRecords?: DataRecord[];
    referenceCollection?: {
        key: any;
        parameters?: Record<string, any>;
    };
    referenceUdm?: string;
    default?: any;
    allowCustom?: boolean;
    $ref?: string;
    required?: string[];
    minLength?: number;
    maxLength?: number;
    minimum?: number;
    maximum?: number;
    maxItems?: number;
    readOnly?: boolean;
    writeOnly?: boolean;
    examples?: any[];
    anyOf?: DataSchema[];
    isImplied?: boolean;
    referenceCollectionPath?: string;
    referenceCollectionUri?: string;
}

Properties

title? description? type? format? properties? items? additionalProperties? enum? referenceRecords? referenceCollection? referenceUdm? default? allowCustom? $ref? required? minLength? maxLength? minimum? maximum? maxItems? readOnly? writeOnly? examples? anyOf? isImplied? referenceCollectionPath? referenceCollectionUri?

Properties

Optionaltitle

title?: string

Human-readable name of the schema.

Optionaldescription

description?: string

Additional information about the field.

Optionaltype

type?: string | string[]

Schema type.

Optionalformat

format?: string

Format for strings.

Optionalproperties

properties?: {
    [key: string]: DataSchema;
}

Properties for object schema

Optionalitems

items?: DataSchema

Schema for array items

OptionaladditionalProperties

additionalProperties?: boolean | DataSchema

For object schemas - whether value can contain properties besides ones listed in properties.

Optionalenum

enum?: string[]

List of possible values for string schema.

OptionalreferenceRecords

referenceRecords?: DataRecord[]

List of Data Records that can be used as possible values.

OptionalreferenceCollection

referenceCollection?: {
    key: any;
    parameters?: Record<string, any>;
}

Pointer to a collection containing records that can be used as possible values.

OptionalreferenceUdm

referenceUdm?: string

For UDM schemas - reference to another UDM

Optionaldefault

default?: any

Default value that will be used if none is provided.

OptionalallowCustom

allowCustom?: boolean

If true, schema allows custom values besides ones in enum, referenceRecords, or refrenceCollectionPath.

Optional$ref

$ref?: string

Reference to an App Data Schema

Optionalrequired

required?: string[]

List of required properties for object schema

OptionalminLength

minLength?: number

Minimum lenght of a string

OptionalmaxLength

maxLength?: number

Maximum length of a string

Optionalminimum

minimum?: number

Minimum value for a number

Optionalmaximum

maximum?: number

Maximum value for a number

OptionalmaxItems

maxItems?: number

Maximum items for array

OptionalreadOnly

readOnly?: boolean

If field can be only read

OptionalwriteOnly

writeOnly?: boolean

If field can be only written but is not returned in responses

Optionalexamples

examples?: any[]

Examples of the field value

OptionalanyOf

anyOf?: DataSchema[]

OptionalisImplied

isImplied?: boolean

Used to indicate that field was not explicitly defined in the schema, but implied from the value.

OptionalreferenceCollectionPath

referenceCollectionPath?: string

Deprecated

  • use referenceCollection instead

OptionalreferenceCollectionUri

referenceCollectionUri?: string

Settings

Member Visibility

On This Page

Properties