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

x/jira/src/version3/parameters/replaceIssueFieldOption.ts>ReplaceIssueFieldOption

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

Properties

optional
replaceWith: number

The ID of the option that will replace the currently selected option.

optional
jql: string

A JQL query that specifies the issues to be updated. For example, project=10000.

optional
overrideScreenSecurity: boolean

Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.

optional
overrideEditableFlag: boolean

Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission.

fieldKey: string

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

Open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager. run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId: number

The ID of the option to be deselected.