Skip to content

Function: getPrioritySchemes() ​

ts
function getPrioritySchemes(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  maxResults?: number;
  schemes?: object[];
  startAt?: number;
  total?: number;
}>;

Defined in: src/server/api/prioritySchemes.ts:14

Returns all priority schemes. All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=schemes.projectKeys

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ maxResults?: number; startAt?: number; }-
parameters.maxResults?numberHow many results on the page should be included. Defaults to 100, maximum is 1000.
parameters.startAt?numberThe page offset, if not specified then defaults to 0
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; maxResults?: number; schemes?: object[]; startAt?: number; total?: number; }>