• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Issue type screen schemes

Postman Collection
OpenAPI

This resource represents issue type screen schemes. Use it to:

  • get issue type screen schemes and a list of the projects that use them.
  • create issue type screen schemes.
  • update issue type screen schemes.
  • delete issue type screen schemes.
  • associate issue type screen schemes with projects.
  • append issue type to screen scheme mappings to issue type screen schemes.
  • remove issue type to screen scheme mappings from issue type screen schemes.
  • update default screen scheme of issue type screen scheme.
GET

Get issue type screen schemes

Returns a paginated list of issue type screen schemes.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:issue-type-screen-scheme:jira

Request

Query parameters

startAt

integer

maxResults

integer

id

array<integer>

queryString

string

orderBy

string

expand

string

Responses

Returned if the request is successful.

application/json

PageBeanIssueTypeScreenScheme

A page of items.

GET/rest/api/3/issuetypescreenscheme
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 { "isLast": true, "maxResults": 100, "startAt": 0, "total": 2, "values": [ { "id": "1", "name": "Default Issue Type Screen Scheme", "description": "The default issue type screen scheme" }, { "id": "10000", "name": "Office issue type screen scheme", "description": "Managing office projects", "projects": { "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "avatarUrls": { "16x16": "secure/projectavatar?size=xsmall&pid=10000", "24x24": "secure/projectavatar?size=small&pid=10000", "32x32": "secure/projectavatar?size=medium&pid=10000", "48x48": "secure/projectavatar?size=large&pid=10000" }, "id": "10000", "key": "EX", "name": "Example", "projectCategory": { "description": "Project category description", "id": "10000", "name": "A project category" }, "projectTypeKey": "ProjectTypeKey{key='software'}", "self": "project/EX", "simplified": false } ] } } ] }
POST

Create issue type screen scheme

Creates an issue type screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira

Request

Request bodyapplication/json

An issue type screen scheme bean.

description

string

issueTypeMappings

array<IssueTypeScreenSchemeMapping>

Required
name

string

Required

Responses

Returned if the request is successful.

application/json

IssueTypeScreenSchemeId

The ID of an issue type screen scheme.

POST/rest/api/3/issuetypescreenscheme
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueTypeMappings": [ { "issueTypeId": "default", "screenSchemeId": "10001" }, { "issueTypeId": "10001", "screenSchemeId": "10002" }, { "issueTypeId": "10002", "screenSchemeId": "10002" } ], "name": "Scrum issue type screen scheme" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
201Response
1 2 3 { "id": "10001" }
GET

Get issue type screen scheme items

Returns a paginated list of issue type screen scheme items.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:issue-type-screen-scheme:jira

Request

Query parameters

startAt

integer

maxResults

integer

issueTypeScreenSchemeId

array<integer>

Responses

Returned if the request is successful.

application/json

PageBeanIssueTypeScreenSchemeItem

A page of items.

GET/rest/api/3/issuetypescreenscheme/mapping
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/mapping`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 { "isLast": true, "maxResults": 100, "startAt": 0, "total": 4, "values": [ { "issueTypeId": "10000", "issueTypeScreenSchemeId": "10020", "screenSchemeId": "10010" }, { "issueTypeId": "10001", "issueTypeScreenSchemeId": "10021", "screenSchemeId": "10010" }, { "issueTypeId": "10002", "issueTypeScreenSchemeId": "10022", "screenSchemeId": "10010" }, { "issueTypeId": "default", "issueTypeScreenSchemeId": "10023", "screenSchemeId": "10011" } ] }
GET

Get issue type screen schemes for projects

Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:issue-type-screen-scheme:jira

Request

Query parameters

startAt

integer

maxResults

integer

projectId

array<integer>

Required

Responses

Returned if the request is successful.

application/json

PageBeanIssueTypeScreenSchemesProjects

A page of items.

GET/rest/api/3/issuetypescreenscheme/project
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/project?projectId={projectId}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "issueTypeScreenScheme": { "id": "1", "name": "Default Issue Type Screen Scheme", "description": "The default issue type screen scheme" }, "projectIds": [ "10000", "10001" ] } ] }
PUT

Assign issue type screen scheme to project

Assigns an issue type screen scheme to a project.

Issue type screen schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira, write:project:jira

Request

Request bodyapplication/json

issueTypeScreenSchemeId

string

projectId

string

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/3/issuetypescreenscheme/project
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueTypeScreenSchemeId": "10001", "projectId": "10002" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/project`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
PUT

Update issue type screen scheme

Updates an issue type screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira

Request

Path parameters

issueTypeScreenSchemeId

string

Required

Request bodyapplication/json

The issue type screen scheme update details.

description

string

name

string

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "description": "Screens for scrum issue types.", "name": "Scrum scheme" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
DEL

Delete issue type screen scheme

Deletes an issue type screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:delete:issue-type-screen-scheme:jira

Request

Path parameters

issueTypeScreenSchemeId

string

Required

Responses

Returned if the issue type screen scheme is deleted.

application/json

any

DEL/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}`, { method: 'DELETE', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
PUT

Append mappings to issue type screen scheme

Appends issue type to screen scheme mappings to an issue type screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira

Request

Path parameters

issueTypeScreenSchemeId

string

Required

Request bodyapplication/json

issueTypeMappings

array<IssueTypeScreenSchemeMapping>

Required

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueTypeMappings": [ { "issueTypeId": "10000", "screenSchemeId": "10001" }, { "issueTypeId": "10001", "screenSchemeId": "10002" }, { "issueTypeId": "10002", "screenSchemeId": "10002" } ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
PUT

Update issue type screen scheme default screen scheme

Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira

Request

Path parameters

issueTypeScreenSchemeId

string

Required

Request bodyapplication/json

screenSchemeId

string

Required

Responses

Returned if the request is successful.

application/json

any

PUT/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "screenSchemeId": "10010" }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
POST

Remove mappings from issue type screen scheme

Removes issue type to screen scheme mappings from an issue type screen scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:issue-type-screen-scheme:jira

Request

Path parameters

issueTypeScreenSchemeId

string

Required

Request bodyapplication/json

issueTypeIds

array<string>

Required

Responses

Returned if the screen scheme mappings are removed from the issue type screen scheme.

application/json

any

POST/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueTypeIds": [ "10000", "10001", "10004" ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
GET

Get issue type screen scheme projects

Returns a paginated list of projects associated with an issue type screen scheme.

Only company-managed projects associated with an issue type screen scheme are returned.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:project:jira, read:avatar:jira, read:project-category:jira

Request

Path parameters

issueTypeScreenSchemeId

integer

Required

Query parameters

startAt

integer

maxResults

integer

query

string

Responses

Returned if the request is successful.

application/json

PageBeanProjectDetails

A page of items.

GET/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "avatarUrls": { "16x16": "secure/projectavatar?size=xsmall&pid=10000", "24x24": "secure/projectavatar?size=small&pid=10000", "32x32": "secure/projectavatar?size=medium&pid=10000", "48x48": "secure/projectavatar?size=large&pid=10000" }, "id": "10000", "key": "EX", "name": "Example", "projectCategory": { "description": "Project category description", "id": "10000", "name": "A project category" }, "projectTypeKey": "ProjectTypeKey{key='software'}", "self": "project/EX", "simplified": false } ] }

Rate this page: