Interface FieldReferenceData

Details of a field that can be used in advanced searches.

interface FieldReferenceData {
    auto?: string;
    cfid?: string;
    deprecated?: string;
    deprecatedSearcherKey?: string;
    displayName?: string;
    operators?: string[];
    orderable?: string;
    searchable?: string;
    types?: string[];
    value?: string;
}

Properties

auto? cfid? deprecated? deprecatedSearcherKey? displayName? operators? orderable? searchable? types? value?

Properties

Optional auto

auto?: string

Whether the field provide auto-complete suggestions.

Optional cfid

cfid?: string

If the item is a custom field, the ID of the custom field.

Optional deprecated

deprecated?: string

Whether this field has been deprecated.

Optional deprecatedSearcherKey

deprecatedSearcherKey?: string

The searcher key of the field, only passed when the field is deprecated.

Optional displayName

displayName?: string

The display name contains the following:

For system fields, the field name. For example, Summary. for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, Component - Component[Dropdown]. for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, Component - cf[10061].

Optional operators

operators?: string[]

The valid search operators for the field.

Optional orderable

orderable?: string

Whether the field can be used in a query's ORDER BY clause.

Optional searchable

searchable?: string

Whether the content of this field can be searched.

Optional types

types?: string[]

The data types of items in the field.

Optional value

value?: string

The field identifier.

Settings

Member Visibility

Theme

On This Page

autocfiddeprecateddeprecatedSearcherKeydisplayNameoperatorsorderablesearchabletypesvalue