Interface FieldReferenceData

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

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

Properties

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

Properties

Optionalauto

auto?: "false" | "true"

Whether the field provide auto-complete suggestions.

Optionalcfid

cfid?: string

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

Optionaldeprecated

deprecated?: "false" | "true"

Whether this field has been deprecated.

OptionaldeprecatedSearcherKey

deprecatedSearcherKey?: string

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

OptionaldisplayName

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].

Optionaloperators

operators?: string[]

The valid search operators for the field.

Optionalorderable

orderable?: "false" | "true"

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

Optionalsearchable

searchable?: "false" | "true"

Whether the content of this field can be searched.

Optionaltypes

types?: string[]

The data types of items in the field.

Optionalvalue

value?: string

The field identifier.

Settings

Member Visibility

On This Page

Properties