Skip to content

Function: getIssueTypeScreenSchemes() ​

ts
function getIssueTypeScreenSchemes(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/issueTypeScreenSchemes.ts:33

Returns a paginated list of issue type screen schemes.

Only issue type screen schemes used in classic projects are returned.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ expand?: string & object | "projects" | (string & object | "projects")[]; id?: number[]; maxResults?: number; orderBy?: "name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"; queryString?: string; startAt?: number; }-
parameters.expand?string & object | "projects" | (string & object | "projects")[]Use expand to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to.
parameters.id?number[]The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.orderBy?"name" | "id" | string & object | "-name" | "+name" | "-id" | "+id"Order the results by a field: - name Sorts by issue type screen scheme name. - id Sorts by issue type screen scheme ID.
parameters.queryString?stringString used to perform a case-insensitive partial match with issue type screen scheme name.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>