Skip to content

Function: reindexIssues() ​

ts
function reindexIssues(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Defined in: src/server/api/indexing.ts:141

Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of the issues has completed or a failure occurs.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ indexChangeHistory?: boolean; indexComments?: boolean; indexWorklogs?: boolean; issueId?: string[]; }-
parameters.indexChangeHistory?booleanIndicates that changeHistory should also be reindexed.
parameters.indexComments?booleanIndicates that comments should also be reindexed.
parameters.indexWorklogs?booleanIndicates that worklogs should also be reindexed.
parameters.issueId?string[]The IDs or keys of one or more issues to reindex.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; currentProgress?: number; currentSubTask?: string; finishTime?: Date; progressUrl?: string; startTime?: Date; submittedTime?: Date; success?: boolean; type?: | string & object | "FOREGROUND" | "BACKGROUND" | "BACKGROUND_PREFFERED" | "BACKGROUND_PREFERRED"; }>