Variable: search

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

Defined in: src/cloud/api/status.ts:248

Returns a paginated list of statuses that match a search on name or project.

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ includeGlobalStatuses?: boolean; maxResults?: number; projectId?: string; searchString?: string; startAt?: number; statusCategory?: string; }	-
parameters.includeGlobalStatuses?	boolean	Whether to include global statuses (scope = null, not tied to any project) in the response. Defaults to false. Only relevant for project scoped queries.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.projectId?	string	The project the status is part of or null for global statuses.
parameters.searchString?	string	Term to match status names against or null to search for all statuses in the search scope.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
parameters.statusCategory?	string	Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.
options?	RequestOptions	-

Returns

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

Deprecated

Renamed to searchStatuses, which calls the same endpoint. This alias is removed in the next major version.