• 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

issuetypescheme

Postman Collection
OpenAPI
Operations
GET/api/2/issuetypeschemePOST/api/2/issuetypeschemeGET/api/2/issuetypescheme/{schemeId}PUT/api/2/issuetypescheme/{schemeId}DEL/api/2/issuetypescheme/{schemeId}GET/api/2/issuetypescheme/{schemeId}/associationsPUT/api/2/issuetypescheme/{schemeId}/associationsPOST/api/2/issuetypescheme/{schemeId}/associationsDEL/api/2/issuetypescheme/{schemeId}/associationsDEL/api/2/issuetypescheme/{schemeId}/associations/{projIdOrKey}
GET

Get list of all issue type schemes visible to user

Returns a list of all issue type schemes visible to the user. All issue types associated with the scheme will only be returned if an additional query parameter is provided: expand=schemes.issueTypes. Similarly, the default issue type associated with the scheme (if one exists) will only be returned if an additional query parameter is provided: expand=schemes.defaultIssueType. Note that both query parameters can be used together: expand=schemes.issueTypes,schemes.defaultIssueType.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returns a list of issue type schemes.

application/json

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

Create an issue type scheme from JSON representation

Creates an issue type scheme from a JSON representation

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

Issue type scheme creation details.

defaultIssueTypeId

string

description

string

issueTypeIDs

array<string>

issueTypeIds

array<string>

name

string

Responses

Returns a JSON representation of the newly created IssueTypeScheme if successful.

application/json

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

Get full representation of issue type scheme by id

Returns a full representation of the issue type scheme that has the given id

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Responses

Returns a full representation of the issue type scheme with the given id.

application/json

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

Update specified issue type scheme from JSON representation

Updates the specified issue type scheme from a JSON representation

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Request bodyapplication/json

Specifies the new set of attributes that the issue type scheme will take on.

defaultIssueTypeId

string

description

string

issueTypeIDs

array<string>

issueTypeIds

array<string>

name

string

Responses

Returns a JSON representation of the updated issue type scheme.

application/json

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

Delete specified issue type scheme

Deletes the specified issue type scheme. Any projects associated with this IssueTypeScheme will be automatically associated with the global default IssueTypeScheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Responses

Confirmation that the delete was successful.

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

Get all of the associated projects for specified scheme

For the specified issue type scheme, returns all of the associated projects

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Query parameters

expand

string

Responses

The collection of projects associated with this issue type scheme.

application/json

ProjectBean
GET/api/2/issuetypescheme/{schemeId}/associations
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/issuetypescheme/{schemeId}/associations' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
PUT

Set project associations for scheme

Associates the given projects with the specified issue type scheme

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Request bodyapplication/json

Collection of projects, specified by id or key, to associate with this issue type scheme

idsOrKeys

array<string>

Responses

Confirmation that the association was successful.

PUT/api/2/issuetypescheme/{schemeId}/associations
1 2 3 4 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/issuetypescheme/{schemeId}/associations' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
POST

Add project associations to scheme

Adds additional projects to those already associated with the specified issue type scheme

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Request bodyapplication/json

Collection of projects, specified by id or key, to associate with this issue type scheme

idsOrKeys

array<string>

Responses

Confirmation that the association was successful.

POST/api/2/issuetypescheme/{schemeId}/associations
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/issuetypescheme/{schemeId}/associations' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
DEL

Remove all project associations for specified scheme

Removes all project associations for the specified issue type scheme

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

schemeId

string

Required

Responses

Confirmation that the associations were removed.

DEL/api/2/issuetypescheme/{schemeId}/associations
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/issuetypescheme/{schemeId}/associations' \ --user 'email@example.com:<api_token>'
DEL

Remove given project association for specified scheme

For the specified issue type scheme, removes the given project association

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

projIdOrKey

string

Required
schemeId

string

Required

Responses

Confirmation that the association was removed.

DEL/api/2/issuetypescheme/{schemeId}/associations/{projIdOrKey}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/issuetypescheme/{schemeId}/associations/{projIdOrKey}' \ --user 'email@example.com:<api_token>'

Rate this page: