Screen schemes

Get screen schemes

Changed on

Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

get/rest/api/3/screenscheme

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/screenscheme
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-project

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.

idinteger[]

The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

expandstring

Use expand include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to.

queryStringstring

String used to perform a case-insensitive partial match with screen scheme name.

orderBy'name' | '-name' | '+name' | 'id' | '-id' | '+id'

Order the results by a field:

  • id Sorts by screen scheme ID.
  • name Sorts by screen scheme name.

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

  • 6abe311e7b55Revision changes
    • info

      the response property /////// became required for the status