v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Screens

Get screens for a field

Returns a paginated list of the screens a field is used in.

Permissions required: Administer Jira global permission.

get/rest/api/2/field/{fieldId}/screens

Path parameters

fieldIdstring required

The ID of the field to return screens for.

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.

expandstring

Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.

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.