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

x/jira/src/version3/parameters/getSelectableIssueFieldOptions.ts>GetSelectableIssueFieldOptions

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

Properties

optional
startAt: number

The index of the first item to return in a page of results (page offset).

optional
maxResults: number

The maximum number of items to return per page.

optional
projectId: number

Filters the results to options that are only available in the specified project.

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"