jira.js
    Preparing search index...

    Function reindex

    • Kicks off a reindex. Need Admin permissions to perform this reindex.

      Parameters

      • client: Client
      • parameters: {
            indexChangeHistory?: boolean;
            indexComments?: boolean;
            indexWorklogs?: boolean;
            type?: string;
        }
        • OptionalindexChangeHistory?: boolean

          Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.

        • OptionalindexComments?: boolean

          Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.

        • OptionalindexWorklogs?: boolean

          Indicates that worklogs should also be reindexed. Not relevant for foreground reindex, where worklogs are always reindexed.

        • Optionaltype?: string

          Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED. Not relevant for Search Platform that only supports BACKGROUND reindexing e.g. OpenSearch.

      • Optionaloptions: RequestOptions

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

    Settings
    Member Visibility