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

x/jira/src/version3/parameters/getFieldsPaginated.ts>GetFieldsPaginated

A JavaScript/TypeScript wrapper for the JIRA Cloud, Service Desk and Agile REST API
Latest
interface GetFieldsPaginated
import { type GetFieldsPaginated } from "https://deno.land/x/jira@v3.0.2/src/version3/parameters/getFieldsPaginated.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
type: ("custom" | "system" | string)[]

The type of fields to search.

optional
id: string[]

The IDs of the custom fields to return or, where query is specified, filter.

optional
query: string

String used to perform a case-insensitive partial match with field names or descriptions.

optional
orderBy:
| "contextsCount"
| "-contextsCount"
| "+contextsCount"
| "lastUsed"
| "-lastUsed"
| "+lastUsed"
| "name"
| "-name"
| "+name"
| "screensCount"
| "-screensCount"
| "+screensCount"
| "projectsCount"
| "-projectsCount"
| "+projectsCount"
| string

Order the results by a field:

  • contextsCount sorts by the number of contexts related to a field
  • lastUsed sorts by the date when the value of the field last changed
  • name sorts by the field name
  • screensCount sorts by the number of screens related to a field
optional
expand:
| "key"
| "lastUsed"
| "screensCount"
| "isLocked"
| "searcherKey"
| (
| "key"
| "lastUsed"
| "screensCount"
| "isLocked"
| "searcherKey"
)[]
| string
| string[]

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • key returns the key for each field
  • lastUsed returns the date when the value of the field last changed
  • screensCount returns the number of screens related to a field contextsCount returns the number of contexts related to a field
  • isLocked returns information about whether the field is locked
  • searcherKey returns the searcher key for each custom field