Interface CorePropertyDefinition

interface CorePropertyDefinition {
    autoIncrement?: boolean;
    defaultValue?:
        | string
        | number
        | boolean
        | object;
    description?: string;
    immutable?: boolean;
    name?: string;
    nullable?: boolean;
}

Properties

autoIncrement? defaultValue? description? immutable? name? nullable?

Properties

OptionalautoIncrement

autoIncrement?: boolean

When set to true, the API will increment the property based on its highest current value (max value). You can only use this functionality to increment properties of type int32 or int64. If the property has a different data type, the API will return an error.

OptionaldefaultValue

defaultValue?:
    | string
    | number
    | boolean
    | object

Default value to use when you do not specify a value for the property. The default value must be of the same type as what you defined for the property itself.

We do not currently support using default values for array/list types.

Optionaldescription

description?: string

Description of the content and suggested use for this property.

Optionalimmutable

immutable?: boolean

Should updates to this property be rejected after the initial population?

Optionalname

name?: string

Readable property name.

Optionalnullable

nullable?: boolean

Does this property need to be set to a value, or not?

Settings

Member Visibility

On This Page

Properties