• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

screens

Postman Collection
OpenAPI
Operations
GET/api/2/screensPOST/api/2/screens/addToDefault/{fieldId}GET/api/2/screens/{screenId}/availableFieldsGET/api/2/screens/{screenId}/tabsPOST/api/2/screens/{screenId}/tabsPUT/api/2/screens/{screenId}/tabs/{tabId}DEL/api/2/screens/{screenId}/tabs/{tabId}GET/api/2/screens/{screenId}/tabs/{tabId}/fieldsPOST/api/2/screens/{screenId}/tabs/{tabId}/fieldsDEL/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}POST/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/movePUT/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}POST/api/2/screens/{screenId}/tabs/{tabId}/move/{pos}
GET

Get available field screens

Adds field or custom field to the default tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

search

string

expand

string

maxResults

string

startAt

string

Responses

Returns response indicating successful addition of field to default screen / default tab.

GET/api/2/screens
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/screens' \ --user 'email@example.com:<api_token>'
POST

Add field to default screen

Moves field on the given tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

fieldId

string

Required

Responses

Returns response indicating field movement.

POST/api/2/screens/addToDefault/{fieldId}
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/screens/addToDefault/{fieldId}' \ --user 'email@example.com:<api_token>'
GET

Get available fields for screen

Gets available fields for screen. i.e ones that haven't already been added.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

screenId

integer

Required

Responses

Returns a list of available fields for the screen.

application/json

ScreenableFieldBean
GET/api/2/screens/{screenId}/availableFields
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/availableFields' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get all tabs for a screen

Returns a list of all tabs for the given screen.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

screenId

integer

Required

Query parameters

projectKey

string

Responses

Returns a list of Jira issue tabs.

application/json

ScreenableTabBean
GET/api/2/screens/{screenId}/tabs
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create tab for a screen

Creates tab for given screen.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

screenId

integer

Required

Request bodyapplication/json

id

integer

name

string

Responses

Returns newly created tab.

application/json

ScreenableTabBean
POST/api/2/screens/{screenId}/tabs
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
PUT

Rename a tab on a screen

Renames tab on given screen.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required

Request bodyapplication/json

id

integer

name

string

Responses

Returns renamed tab.

application/json

ScreenableTabBean
PUT/api/2/screens/{screenId}/tabs/{tabId}
1 2 3 4 5 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Delete a tab from a screen

Deletes tab from given screen.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required

Responses

Returns response indicating tab deletion.

DEL/api/2/screens/{screenId}/tabs/{tabId}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}' \ --user 'email@example.com:<api_token>'
GET

Get all fields for a tab

Gets all fields for a given tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required

Query parameters

projectKey

string

Responses

Returns a list of all fields for the given tab.

application/json

ScreenableFieldBean
GET/api/2/screens/{screenId}/tabs/{tabId}/fields
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/fields' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Add field to a tab

Adds field to the given tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required

Request bodyapplication/json

fieldId

string

Responses

Returns newly added field.

application/json

ScreenableFieldBean
POST/api/2/screens/{screenId}/tabs/{tabId}/fields
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/fields' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Remove field from tab

Removes field from given tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required
id

string

Required

Responses

Returns response indicating field removal.

DEL/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}' \ --user 'email@example.com:<api_token>'
POST

Move field on a tab

Moves field on the given tab.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required
id

string

Required

Request bodyapplication/json

after

string

position

string

Responses

Returns response indicating field movement.

POST/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
PUT

Update 'showWhenEmptyIndicator' for a field

Update 'showWhenEmptyIndicator' for given field on screen.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required
newValue

boolean

Required
id

string

Required

Responses

Returns response indicating the update of 'showWhenEmptyIndicator'.

PUT/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}
1 2 3 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}' \ --user 'email@example.com:<api_token>'
POST

Move tab position

Moves tab position.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

tabId

integer

Required
screenId

integer

Required
pos

integer

Required

Responses

Returns response indicating tab movement.

POST/api/2/screens/{screenId}/tabs/{tabId}/move/{pos}
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/screens/{screenId}/tabs/{tabId}/move/{pos}' \ --user 'email@example.com:<api_token>'

Rate this page: