jira-rest-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Details of a custom field.

Hierarchy

  • UpdateCustomFieldDetails

Index

Properties

Properties

Optional description

description: string

The description of the custom field. The maximum length is 40000 characters.

Optional name

name: string

The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.

Optional searcherKey

searcherKey: "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:daterange" | "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange" | "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber" | "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:numberrange" | "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher" | "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"

The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):

  • cascadingselect: cascadingselectsearcher
  • datepicker: daterange
  • datetime: datetimerange
  • float: exactnumber or numberrange
  • grouppicker: grouppickersearcher
  • importid: exactnumber or numberrange
  • labels: labelsearcher
  • multicheckboxes: multiselectsearcher
  • multigrouppicker: multiselectsearcher
  • multiselect: multiselectsearcher
  • multiuserpicker: userpickergroupsearcher
  • multiversion: versionsearcher
  • project: projectsearcher
  • radiobuttons: multiselectsearcher
  • readonlyfield: textsearcher
  • select: multiselectsearcher
  • textarea: textsearcher
  • textfield: textsearcher
  • url: exacttextsearcher
  • userpicker: userpickergroupsearcher
  • version: versionsearcher

Legend

  • Namespace
  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc