jira.js
    Preparing search index...

    Function getTrashedFieldsPaginated

    • Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string.

      Only custom fields can be queried, type must be set to custom.

      Permissions required: Administer Jira global permission.

      Parameters

      • client: Client
      • Optionalparameters: {
            expand?:
                | "name"
                | string & {}
                | "projectsCount"
                | "-name"
                | "+name"
                | "-projectsCount"
                | "+projectsCount"
                | "trashDate"
                | "-trashDate"
                | "+trashDate"
                | "plannedDeletionDate"
                | "-plannedDeletionDate"
                | "+plannedDeletionDate";
            id?: string[];
            maxResults?: number;
            orderBy?: | "name"
            | string & {}
            | "-name"
            | "+name"
            | "trashDate"
            | "-trashDate"
            | "+trashDate"
            | "plannedDeletionDate"
            | "-plannedDeletionDate"
            | "+plannedDeletionDate";
            query?: string;
            startAt?: number;
        }
        • Optionalexpand?:
              | "name"
              | string & {}
              | "projectsCount"
              | "-name"
              | "+name"
              | "-projectsCount"
              | "+projectsCount"
              | "trashDate"
              | "-trashDate"
              | "+trashDate"
              | "plannedDeletionDate"
              | "-plannedDeletionDate"
              | "+plannedDeletionDate"
        • Optionalid?: string[]
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalorderBy?:
              | "name"
              | string & {}
              | "-name"
              | "+name"
              | "trashDate"
              | "-trashDate"
              | "+trashDate"
              | "plannedDeletionDate"
              | "-plannedDeletionDate"
              | "+plannedDeletionDate"

          Order the results by a field:

          • name sorts by the field name
          • trashDate sorts by the date the field was moved to the trash
          • plannedDeletionDate sorts by the planned deletion date
        • Optionalquery?: string

          String used to perform a case-insensitive partial match with field names or descriptions.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  areOptionsSupported?: boolean;
                  contextsCount?: number;
                  description?: string;
                  id: string;
                  isLocked?: boolean;
                  isOptionsCountOverLimit?: boolean;
                  isUnscreenable?: boolean;
                  key?: string;
                  lastUsed?: {
                      type?: string & {}
                      | "TRACKED"
                      | "NOT_TRACKED"
                      | "NO_INFORMATION";
                      value?: Date;
                      [key: string]: unknown;
                  };
                  name: string;
                  projectsCount?: number;
                  schema: {
                      configuration?: Record<string, any>;
                      custom?: string;
                      customId?: number;
                      items?: string;
                      system?: string;
                      type: string;
                      [key: string]: unknown;
                  };
                  screensCount?: number;
                  searcherKey?: string;
                  stableId?: string;
                  translatedDescription?: string;
                  translatedName?: string;
                  typeDisplayName?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility