Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General information


Info

Available since v. 1.2.0

Available since v. 1.23.* - Added Pagination




Method type - 

Status
colourGreen
titleGET

URL:

  • {JIRA_URL}/rest/extender/1.0/screen/all

Response format - JSON

Example

Code Block
languagejs
themeFadeToGrey
titleJSON response
{
	"total": 100,
	"maxResults": 1000,
    "startAt": 0,
    "screens": [
        {
            "name": "Default Screen",
            "tabs": [
                {
                    "name": "Field Tab",
                    "id": "10000",
                    "position": "0"
                },
                {
                    "name": "New tab",
                    "id": "10100",
                    "position": "1"
                }
            ],
            "id": "1"
        },
        {
            "name": "Resolve Issue Screen",
            "tabs": [
                {
                    "name": "Field Tab",
                    "id": "10002",
                    "position": "0"
                }
            ],
            "id": "3"
        },
        {
            "name": "Workflow Screen",
            "tabs": [
                {
                    "name": "Field Tab",
                    "id": "10001",
                    "position": "0"
                }
            ],
            "id": "2"
        }
    ]
}




Pagination

This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:

Code Block
themeFadeToGrey
{
    "startAt" : 0,
    "maxResults" : 10,
    "total": 200,
    "screens": [
        { /* result 0 */ },
        { /* result 1 */ },
        { /* result 2 */ }
    ]
}

Where:

  • startAt is the index of the first item returned in the page of results.
  • maxResults is the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)
  • total is the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.

Example:

  • {JIRA_URL}/rest/extender/1.0/screen/all?startAt=10&maxResults=20
  • {JIRA_URL}/rest/extender/1.0/screen/all?maxResults=1000