Skip to content

Function: getTrashedFieldsPaginated() ​

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

Defined in: src/cloud/api/issueFields.ts:118

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 ​

ParameterTypeDescription
clientClient-
parameters?{ expand?: | "name" | string & object | "projectsCount" | "-name" | "+name" | "-projectsCount" | "+projectsCount" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"; id?: string[]; maxResults?: number; orderBy?: | "name" | string & object | "-name" | "+name" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"; query?: string; startAt?: number; }-
parameters.expand?| "name" | string & object | "projectsCount" | "-name" | "+name" | "-projectsCount" | "+projectsCount" | "trashDate" | "-trashDate" | "+trashDate" | "plannedDeletionDate" | "-plannedDeletionDate" | "+plannedDeletionDate"-
parameters.id?string[]-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.orderBy?| "name" | string & object | "-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
parameters.query?stringString used to perform a case-insensitive partial match with field names or descriptions.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-

Returns ​

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