Issue fields

Owned by Comala Publishing for Confluence Cloud
Nov 19, 2024
5 min read

General APIs

setValue

setValue(value: unknown): FieldAPI

Set a given field's value. See the specific field value contracts in the Field details section below to make sure the changes requested by this method will be applied.

getValue

getValue(): unknown

See the field contracts below to learn the shape of the data returned by each field.

Field details

issue type

type: issuetype

setValue signature

Warning

The execution of the setValue method will initiate a UIM context change. Issue type is a part of the UIM invocation context. Changing the issue type with setValue changes that context.

UI modifications won’t be applied to an issue type field that’s out of the UIM app invocation context.

Note that issue types have different UIM app invocation contexts, so UIM functionality may not be applied the same way, in particular when it comes to setting visibility of options.

setValue(id: string): FieldAPI

getValue signature

issue type field shape

priority

type: priority

setValue signature

getValue signature

Priority field shape

summary

type: summary

setValue signature

getValue signature

Summary field shape

assignee

type: assignee

setValue signature

Special values

An accountId of "-1" is used for the "Automatic" assignee value. null is used for the "Unassigned" value. For more information on the "Automatic" assignee value, see Automatically assign issues to people | Jira Cloud | Atlassian Support

getValue signature

Assignee field shape

Known limitation

The number of unique accountIds that can be set via the setValue method can't be greater than 90 per one batched update.

This means that all calls to setValue for user-based fields performed in a single onInit or onChange callback are counted against this limit.

reporter

type: reporter

setValue signature

getValue signature

reporter field shape

labels

type: labels

setValue signature

getValue signature

labels field shape

description

type: description

setValue signature

getValue signature

description field shape (Global issue create)

description field shape (Issue view)

components

type: components

Field usage

This field is only available in company-managed projects.

setValue signature

getValue signature

components field shape

fix versions

type: fixVersions

setValue signature

getValue signature

fix versions field shape

single select

type: com.atlassian.jira.plugin.system.customfieldtypes:select

setValue signature

getValue signature

select field shape

multi select

type: com.atlassian.jira.plugin.system.customfieldtypes:multiselect

setValue signature

getValue signature

multi select field shape

checkboxes

type: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes

setValue signature

getValue signature

checkboxes field shape

radio buttons

type: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons

setValue signature

getValue signature

radio buttons field shape

paragraph

type: com.atlassian.jira.plugin.system.customfieldtypes:textarea

setValue signature

getValue signature

paragraph field shape

text field

type: com.atlassian.jira.plugin.system.customfieldtypes:textfield

setValue signature

getValue signature

text field shape

user picker

type: com.atlassian.jira.plugin.system.customfieldtypes:userpicker

setValue signature

getValue signature

user picker field shape

multi user picker

type: com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker

setValue signature

getValue signature

multi user picker field shape

people

type: com.atlassian.jira.plugin.system.customfieldtypes:people

setValue signature

getValue signature

people field shape

url

type: com.atlassian.jira.plugin.system.customfieldtypes:url

setValue signature

getValue signature

url field shape

date picker

type: com.atlassian.jira.plugin.system.customfieldtypes:datepicker

setValue signature

getValue signature

date picker field shape

date time picker

type: com.atlassian.jira.plugin.system.customfieldtypes:datetime

setValue signature

getValue signature

date picker field shape

number

type: com.atlassian.jira.plugin.system.customfieldtypes:float

setValue signature

getValue signature

number custom field shape

parent

type: parent

setValue signature

getValue signature

parent field shape

 

Â