Skip to main content
The Deno 2 Release Candidate is here
Learn more
Module

x/jira/src/version3/models/fieldReferenceData.ts>FieldReferenceData

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface FieldReferenceData
import { type FieldReferenceData } from "https://deno.land/x/jira@v3.0.2/src/version3/models/fieldReferenceData.ts";

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

Properties

optional
value: string

The field identifier.

optional
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
orderable: string

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

optional
searchable: string

Whether the content of this field can be searched.

optional
deprecated: string

Whether this field has been deprecated.

optional
deprecatedSearcherKey: string

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

optional
auto: string

Whether the field provide auto-complete suggestions.

optional
cfid: string

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

optional
operators: string[]

The valid search operators for the field.

optional
types: string[]

The data types of items in the field.