Jira.js - Jira Cloud API library
    Preparing search index...

    Interface JiraIssueFields

    Index

    Properties

    cascadingSelectFields?: JiraCascadingSelectField[]

    Add or clear a cascading select field:

    • To add, specify optionId for both parent and child.
    • To clear the child, set its optionId to null.
    • To clear both, set the parent's optionId to null.
    clearableNumberFields?: JiraNumberField[]

    Add or clear a number field:

    • To add, specify a numeric value.
    • To clear, set value to null.
    colorFields?: JiraColorField[]

    Add or clear a color field:

    • To add, specify the color name. Available colors are: purple, blue, green, teal, yellow, orange, grey, dark purple, dark blue, dark green, dark teal, dark yellow, dark orange, dark grey.
    • To clear, set the color name to an empty string.
    datePickerFields?: JiraDateField[]

    Add or clear a date picker field:

    • To add, specify the date in d/mmm/yy format or ISO format dd-mm-yyyy.
    • To clear, set formattedDate to an empty string.
    dateTimePickerFields?: JiraDateTimeField[]

    Add or clear the planned start date and time:

    • To add, specify the date and time in ISO format for formattedDateTime.
    • To clear, provide an empty string for formattedDateTime.
    issueType?: JiraIssueTypeField
    labelsFields?: JiraLabelsField[]

    Edit a labels field:

    • Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits.
    • To clear labels, use the REMOVE_ALL option with an empty labels array.
    multipleGroupPickerFields?: JiraMultipleGroupPickerField[]

    Add or clear a multi-group picker field:

    • To add groups, provide an array of groups with groupNames.
    • To clear all groups, use an empty groups array.
    multipleSelectClearableUserPickerFields?: JiraMultipleSelectUserPickerField[]

    Assign or unassign multiple users to/from a field:

    • To assign, provide an array of user accountIds.
    • To clear, set users to null.
    multipleSelectFields?: JiraMultipleSelectField[]

    Add or clear a multi-select field:

    • To add, provide an array of options with optionIds.
    • To clear, use an empty options array.
    multipleVersionPickerFields?: JiraMultipleVersionPickerField[]

    Edit a multi-version picker field like Fix Versions/Affects Versions:

    • Options include ADD, REPLACE, REMOVE, or REMOVE_ALL for bulk edits.
    • To clear the field, use the REMOVE_ALL option with an empty versions array.
    multiselectComponents?: JiraMultiSelectComponentField
    originalEstimateField?: JiraDurationField
    richTextFields?: JiraRichTextField[]

    Add or clear a rich text field:

    • To add, provide adfValue. Note that rich text fields only support ADF values.

    • To clear, use an empty richText object.

      For ADF format details, refer to: Atlassian Document Format.

    singleGroupPickerFields?: JiraSingleGroupPickerField[]

    Add or clear a single group picker field:

    • To add, specify the group with groupName.
    • To clear, set groupName to an empty string.
    singleLineTextFields?: JiraSingleLineTextField[]

    Add or clear a single line text field:

    • To add, provide the text value.
    • To clear, set text to an empty string.
    singleSelectClearableUserPickerFields?: JiraSingleSelectUserPickerField[]

    Edit assignment for single select user picker fields like Assignee/Reporter:

    • To assign an issue, specify the user's accountId.
    • To unassign an issue, set user to null.
    • For automatic assignment, set accountId to -1.
    singleSelectFields?: JiraSingleSelectField[]

    Add or clear a single select field:

    • To add, specify the option with an optionId.
    • To clear, pass an option with optionId as -1.
    singleVersionPickerFields?: JiraSingleVersionPickerField[]

    Add or clear a single version picker field:

    • To add, specify the version with a versionId.
    • To clear, set versionId to -1.
    timeTrackingField?: JiraTimeTrackingField
    urlFields?: JiraUrlField[]

    Add or clear a URL field:

    • To add, provide the url with the desired URL value.
    • To clear, set url to an empty string.