• 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.

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.

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.

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