Skip to content

Function: getPaginatedStatuses() ​

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

Defined in: src/server/api/workflowStatuses.ts:22

Returns paginated list of filtered statuses

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ issueTypeIds?: string[]; maxResults?: number; projectIds?: number[]; query?: string; startAt?: number; }-
parameters.issueTypeIds?string[]The list of issue type ids to filter statuses.
parameters.maxResults?numberThe maximum number of statuses to return.
parameters.projectIds?number[]The list of project ids to filter statuses.
parameters.query?stringThe string that status names will be matched with.
parameters.startAt?numberThe index of the first status to return.
options?RequestOptions-

Returns ​

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