Interface FieldDetails

Details about a field.

interface FieldDetails {
    clauseNames?: string[];
    custom?: boolean;
    id?: string;
    key?: string;
    name?: string;
    navigable?: boolean;
    orderable?: boolean;
    schema?: JsonTypeBean;
    scope?: Scope;
    searchable?: boolean;
}

Properties

clauseNames? custom? id? key? name? navigable? orderable? schema? scope? searchable?

Properties

OptionalclauseNames

clauseNames?: string[]

The names that can be used to reference the field in an advanced search. For more information, see Advanced searching - fields reference.

Optionalcustom

custom?: boolean

Whether the field is a custom field.

Optionalid

id?: string

The ID of the field.

Optionalkey

key?: string

The key of the field.

Optionalname

name?: string

The name of the field.

Optionalnavigable

navigable?: boolean

Whether the field can be used as a column on the issue navigator.

Optionalorderable

orderable?: boolean

Whether the content of the field can be used to order lists.

Optionalschema

schema?: JsonTypeBean

The data schema for the field.

Optionalscope

scope?: Scope

The scope of the field.

Optionalsearchable

searchable?: boolean

Whether the content of the field can be searched.

Settings

Member Visibility

On This Page

Properties