Skip to content

Function: searchUsingSearchRequest() ​

ts
function searchUsingSearchRequest(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Defined in: src/server/api/issueSearch.ts:41

Performs a search using JQL.

Parameters ​

ParameterType
clientClient
parameters{ expand?: string[]; fields?: string[]; jql?: string; maxResults?: number; startAt?: number; validateQuery?: boolean; }
parameters.expand?string[]
parameters.fields?string[]
parameters.jql?string
parameters.maxResults?number
parameters.startAt?number
parameters.validateQuery?boolean
options?RequestOptions

Returns ​

Promise<{ [key: string]: unknown; expand?: string | null; issues?: object[]; maxResults?: number; maxResultWindow?: number; names?: Record<string, string> | null; schema?: | Record<string, { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }> | null; startAt?: number; total?: number; warningMessages?: string[] | null; }>