Issue fields

Get fields in trash paginated

Changed on

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.

get/rest/api/3/field/search/trashed

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/field/search/trashed
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

idstring[]
querystring

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

expand'name' | '-name' | '+name' | 'trashDate' | '-trashDate' | '+trashDate' | 'plannedDeletionDate' | '-plannedDeletionDate' | '+plannedDeletionDate' | 'projectsCount' | '-projectsCount' | '+projectsCount'
orderBystring

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

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 23cd462c2497Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 10c4041677d4Revision changes
    • info

      added the optional property // to the response with the status