Atlassian Jira Issue Type Screen Scheme API
The Atlassian Jira Issue Type Screen Scheme API enables customizing the screens displayed for different issue types.
OpenAPI Specification
components:
schemas:
PageBeanIssueTypeScreenSchemeItem:
additionalProperties: false
description: A page of items.
properties:
isLast:
description: Whether this is the last page.
readOnly: true
type: boolean
maxResults:
description: The maximum number of items that could be returned.
format: int32
readOnly: true
type: integer
nextPage:
description: If there is another page of results, the URL of the next page.
format: uri
readOnly: true
type: string
self:
description: The URL of the page.
format: uri
readOnly: true
type: string
startAt:
description: The index of the first item returned.
format: int64
readOnly: true
type: integer
total:
description: The number of items returned.
format: int64
readOnly: true
type: integer
values:
description: The list of items.
items:
$ref: '#/components/schemas/IssueTypeScreenSchemeItem'
readOnly: true
type: array
type: object
PageBeanIssueTypeScreenSchemesProjects:
additionalProperties: false
description: A page of items.
properties:
isLast:
description: Whether this is the last page.
readOnly: true
type: boolean
maxResults:
description: The maximum number of items that could be returned.
format: int32
readOnly: true
type: integer
nextPage:
description: If there is another page of results, the URL of the next page.
format: uri
readOnly: true
type: string
self:
description: The URL of the page.
format: uri
readOnly: true
type: string
startAt:
description: The index of the first item returned.
format: int64
readOnly: true
type: integer
total:
description: The number of items returned.
format: int64
readOnly: true
type: integer
values:
description: The list of items.
items:
$ref: '#/components/schemas/IssueTypeScreenSchemesProjects'
readOnly: true
type: array
type: object
PageBeanProjectDetails:
additionalProperties: false
description: A page of items.
properties:
isLast:
description: Whether this is the last page.
readOnly: true
type: boolean
maxResults:
description: The maximum number of items that could be returned.
format: int32
readOnly: true
type: integer
nextPage:
description: If there is another page of results, the URL of the next page.
format: uri
readOnly: true
type: string
self:
description: The URL of the page.
format: uri
readOnly: true
type: string
startAt:
description: The index of the first item returned.
format: int64
readOnly: true
type: integer
total:
description: The number of items returned.
format: int64
readOnly: true
type: integer
values:
description: The list of items.
items:
$ref: '#/components/schemas/ProjectDetails'
readOnly: true
type: array
type: object
externalDocs:
description: Find out more about Atlassian products and services.
url: http://www.atlassian.com
info:
contact:
email: [email protected]
description: Needs description.
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
termsOfService: http://atlassian.com/terms/
title: 'Atlassian rest/api/3/issuetypescreenscheme/'
version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
openapi: 3.0.1
paths:
/rest/api/3/issuetypescreenscheme/mapping:
get:
deprecated: false
description: >-
Returns a [paginated](#pagination) list of issue type screen scheme
items.<br><br>Only issue type screen schemes used in classic projects
are returned.<br><br>**[Permissions](#permissions) required:**
*Administer Jira* [global
permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianGetissuetypescreenschememappings
parameters:
- description: >-
The index of the first item to return in a page of results (page
offset).
in: query
name: startAt
schema:
default: 0
format: int64
type: integer
- description: The maximum number of items to return per page.
in: query
name: maxResults
schema:
default: 50
format: int32
type: integer
- description: >-
The list of issue type screen scheme IDs. To include multiple issue
type screen schemes, separate IDs with ampersand:
`issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`.
in: query
name: issueTypeScreenSchemeId
schema:
items:
format: int64
type: integer
type: array
uniqueItems: true
responses:
'200':
content:
application/json:
example: >-
{"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"}]}
schema:
$ref: '#/components/schemas/PageBeanIssueTypeScreenSchemeItem'
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the required permissions.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Get Issue Type Screen Scheme Items
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/project:
get:
deprecated: false
description: >-
Returns a [paginated](#pagination) list of issue type screen schemes
and, for each issue type screen scheme, a list of the projects that use
it.<br><br>Only issue type screen schemes used in classic projects are
returned.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianGetissuetypescreenschemeprojectassociations
parameters:
- description: >-
The index of the first item to return in a page of results (page
offset).
in: query
name: startAt
schema:
default: 0
format: int64
type: integer
- description: The maximum number of items to return per page.
in: query
name: maxResults
schema:
default: 50
format: int32
type: integer
- description: >-
The list of project IDs. To include multiple projects, separate IDs
with ampersand: `projectId=10000&projectId=10001`.
in: query
name: projectId
required: true
schema:
items:
format: int64
type: integer
type: array
uniqueItems: true
responses:
'200':
content:
application/json:
example: >-
{"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"]}]}
schema:
$ref: '#/components/schemas/PageBeanIssueTypeScreenSchemesProjects'
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the required permissions.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Get Issue Type Screen Schemes For Projects
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
put:
deprecated: false
description: >-
Assigns an issue type screen scheme to a project.<br><br>Issue type
screen schemes can only be assigned to classic
projects.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianAssignissuetypescreenschemetoproject
parameters: []
requestBody:
content:
application/json:
example:
issueTypeScreenSchemeId: '10001'
projectId: '10002'
schema:
$ref: '#/components/schemas/IssueTypeScreenSchemeProjectAssociation'
required: true
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: >-
{"errorMessages":["Only classic projects can have issue type
screen schemes assigned."],"errors":{}}
description: |-
Returned if:
* project is not found.
* issue type screen scheme is not found.
* the project is not a classic project.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
content:
application/json:
example: >-
{"errorMessages":["Only Jira administrators can access issue
type screen schemes."],"errors":{}}
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: Returned if the issue type screen scheme or the project are missing.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Assign Issue Type Screen Scheme To Project
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:issue-type-screen-scheme:jira
- write:project:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}:
delete:
deprecated: false
description: >-
Deletes an issue type screen
scheme.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianDeleteissuetypescreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
type: string
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the issue type screen scheme is deleted.
'400':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme cannot be
deleted because it is assigned to one or more
projects."],"errors":{}}
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: Returned if the issue type screen scheme is not found.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Delete Issue Type Screen Scheme
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- delete:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
put:
deprecated: false
description: >-
Updates an issue type screen
scheme.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianUpdateissuetypescreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
description: Screens for scrum issue types.
name: Scrum scheme
schema:
$ref: '#/components/schemas/IssueTypeScreenSchemeUpdateDetails'
description: The issue type screen scheme update details.
required: true
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme name is in
use."],"errors":{}}
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
content:
application/json:
example: >-
{"errorMessages":["Only Jira administrators can access issue
type screen schemes."],"errors":{}}
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: Returned if the issue type screen scheme is not found.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Update Issue Type Screen Scheme
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping:
put:
deprecated: false
description: >-
Appends issue type to screen scheme mappings to an issue type screen
scheme.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianAppendmappingsforissuetypescreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
issueTypeMappings:
- issueTypeId: '10000'
screenSchemeId: '10001'
- issueTypeId: '10001'
screenSchemeId: '10002'
- issueTypeId: '10002'
screenSchemeId: '10002'
schema:
$ref: '#/components/schemas/IssueTypeScreenSchemeMappingDetails'
required: true
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: >-
{"errorMessages":["A default mapping cannot be
added."],"errors":{}}
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: >-
Returned if the issue type screen scheme, issue type, or screen
scheme is not found.
'409':
content:
application/json:
example: >-
{"errorMessages":["Sub-tasks are disabled in Jira. At least one
of the issue types is a sub-task."],"errors":{}}
description: >-
Returned if the issue type is a sub-task, but sub-tasks are disabled
in Jira settings.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Append Mappings To Issue Type Screen Scheme
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default:
put:
deprecated: false
description: >-
Updates the default screen scheme of an issue type screen scheme. The
default screen scheme is used for all unmapped issue
types.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianUpdatedefaultscreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
screenSchemeId: '10010'
schema:
$ref: '#/components/schemas/UpdateDefaultScreenScheme'
required: true
responses:
'204':
content:
application/json:
schema: {}
description: Returned if the request is successful.
'400':
content:
application/json:
example: >-
{"errorMessages":["The screenSchemeId has to be
provided."],"errors":{}}
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
content:
application/json:
example: >-
{"errorMessages":["Only Jira administrators can access issue
type screen schemes."],"errors":{}}
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: >-
Returned if the issue type screen scheme or the screen scheme is not
found, or the screen scheme isn't used in classic projects.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Update Issue Type Screen Scheme Default Screen Scheme
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove:
post:
deprecated: false
description: >-
Removes issue type to screen scheme mappings from an issue type screen
scheme.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianRemovemappingsfromissuetypescreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
issueTypeIds:
- '10000'
- '10001'
- '10004'
schema:
$ref: '#/components/schemas/IssueTypeIds'
required: true
responses:
'204':
content:
application/json:
schema: {}
description: >-
Returned if the screen scheme mappings are removed from the issue
type screen scheme.
'400':
content:
application/json:
example: >-
{"errorMessages":["The issueTypeIds must not contain
duplicates."],"errors":{}}
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
content:
application/json:
example: >-
{"errorMessages":["Only Jira administrators can access issue
type screen schemes."],"errors":{}}
description: Returned if the user does not have the required permissions.
'404':
content:
application/json:
example: >-
{"errorMessages":["The issue type screen scheme was not
found."],"errors":{}}
description: >-
Returned if the issue type screen scheme or one or more issue type
mappings are not found.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Remove Mappings From Issue Type Screen Scheme
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- write:issue-type-screen-scheme:jira
state: Beta
x-atlassian-connect-scope: ADMIN
/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project:
get:
deprecated: false
description: >-
Returns a [paginated](#pagination) list of projects associated with an
issue type screen scheme.<br><br>Only company-managed projects
associated with an issue type screen scheme are
returned.<br><br>**[Permissions](#permissions) required:** *Administer
Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
operationId: atlassianGetprojectsforissuetypescreenscheme
parameters:
- description: The ID of the issue type screen scheme.
in: path
name: issueTypeScreenSchemeId
required: true
schema:
format: int64
type: integer
- description: >-
The index of the first item to return in a page of results (page
offset).
in: query
name: startAt
schema:
default: 0
format: int64
type: integer
- description: The maximum number of items to return per page.
in: query
name: maxResults
schema:
default: 50
format: int32
type: integer
- in: query
name: query
schema:
default: ''
type: string
responses:
'200':
content:
application/json:
example: >-
{"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}]}
schema:
$ref: '#/components/schemas/PageBeanProjectDetails'
description: Returned if the request is successful.
'400':
description: Returned if the request is not valid.
'401':
description: Returned if the authentication credentials are incorrect or missing.
'403':
description: Returned if the user does not have the required permissions.
security:
- basicAuth: []
- OAuth2:
- manage:jira-configuration
summary: Atlassian Get Issue Type Screen Scheme Projects
tags:
- Issue Type Screen Schemes
x-atlassian-data-security-policy:
- app-access-rule-exempt: true
x-atlassian-oauth2-scopes:
- scheme: OAuth2
scopes:
- manage:jira-configuration
state: Current
- scheme: OAuth2
scopes:
- read:project:jira
- read:avatar:jira
- read:project-category:jira
state: Beta
x-atlassian-connect-scope: ADMIN
servers:
- url: https://your-domain.atlassian.net
tags:
- name: Issue Type Screen Schemes
x-atlassian-narrative:
documents:
- anchor: about
body: >-
The Jira REST API enables you to interact with Jira programmatically.
Use this API to
[build
apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/),
script interactions with
Jira, or develop any other type of integration. This page documents the
REST resources available in Jira Cloud, including
the HTTP response codes and example requests and responses.
title: About
- anchor: version
body: >
This documentation is for **version 3** of the Jira Cloud platform REST
API, which is the latest version
but is in **beta**. [Version
2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and
version 3 of the API offer the same collection of operations. However,
version 3 provides support for
the [Atlassian Document
Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)
(ADF) in:
- `body` in comments, including where comments are used in issue, issue
link, and transition resources.
- `comment` in worklogs.
- `description` and `environment` fields in issues.
- `textarea` type custom fields (multi-line text fields) in issues.
Single line custom fields
(`textfield`) accept a string and don't handle Atlassian Document Format content.
However, these new features are under development and may change.
title: Version
- anchor: authentication
body: >
### Forge apps
For Forge apps, [REST API
scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/)
are used when authenticating with Jira Cloud platform. See [Add scopes
to call an Atlassian REST
API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/)
for more details.
The URIs for Forge app REST API calls have this structure:
`/rest/api/3/<resource-name>`
For example, `/rest/api/3/issue/DEMO-1`
### Connect apps
For Connect apps, authentication (JWT-based) is built into the Connect
libraries. Authorization is implemented using either
scopes (shown as _App scope required_ for operations on this page) or
user impersonation. See
[Security for Connect
apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/)
for details.
The URIs for Connect app REST API calls have this structure:
`https://<site-url>/rest/api/3/<resource-name>`
For example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`
### Other integrations
For integrations that are not Forge or Connect apps, use OAuth 2.0
authorization code grants (3LO) for security
(3LO scopes are shown as for operations _OAuth scopes required_). See
[OAuth 2.0 (3LO)
apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/)
for details.
The URIs for OAuth 2.0 (3LO) app REST API calls have this structure:
`https://api.atlassian.com/ex/jira/<cloudId>/rest/api/3/<resource-name>`
For example,
`https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`
### Ad-hoc API calls
For personal scripts, bots, and ad-hoc execution of the REST APIs use
basic authenticati
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/openapi/atlassian-rest-api-3-issuetypescreenscheme--openapi-original.yml