Interface Field

Details of a field.

interface Field {
    contextsCount?: number;
    description?: string;
    id: string;
    isLocked?: boolean;
    isUnscreenable?: boolean;
    key?: string;
    lastUsed?: FieldLastUsed;
    name: string;
    projectsCount?: number;
    schema: JsonTypeBean;
    screensCount?: number;
    searcherKey?: string;
    stableId?: string;
    typeDisplayName?: string;
}

Properties

contextsCount? description? id isLocked? isUnscreenable? key? lastUsed? name projectsCount? schema screensCount? searcherKey? stableId? typeDisplayName?

Properties

OptionalcontextsCount

contextsCount?: number

Number of contexts where the field is used.

Optionaldescription

description?: string

The description of the field.

id

id: string

The ID of the field.

OptionalisLocked

isLocked?: boolean

Whether the field is locked.

OptionalisUnscreenable

isUnscreenable?: boolean

Whether the field is shown on screen or not.

Optionalkey

key?: string

The key of the field.

OptionallastUsed

lastUsed?: FieldLastUsed

Information about the most recent use of a field.

name

name: string

The name of the field.

OptionalprojectsCount

projectsCount?: number

Number of projects where the field is used.

schema

schema: JsonTypeBean

The schema of a field.

OptionalscreensCount

screensCount?: number

Number of screens where the field is used.

OptionalsearcherKey

searcherKey?: string

The searcher key of the field. Returned for custom fields.

OptionalstableId

stableId?: string

The stable ID of the field.

OptionaltypeDisplayName

typeDisplayName?: string

The display name of the field type

Settings

Member Visibility

On This Page

Properties