Server
Jira Data Center / Reference / REST API

issuetype

Postman Collection
Operations
GET/api/2/issuetypePOST/api/2/issuetypeGET/api/2/issuetype/pageGET/api/2/issuetype/{id}PUT/api/2/issuetype/{id}DEL/api/2/issuetype/{id}GET/api/2/issuetype/{id}/alternativesPOST/api/2/issuetype/{id}/avatarPOST/api/2/issuetype/{id}/avatar/temporaryGET/api/2/issuetype/{issueTypeId}/propertiesGET/api/2/issuetype/{issueTypeId}/properties/{propertyKey}PUT/api/2/issuetype/{issueTypeId}/properties/{propertyKey}DEL/api/2/issuetype/{issueTypeId}/properties/{propertyKey}
GET

Get list of all issue types visible to user

Returns a list of all issue types visible to the user

Request

This request has no parameters.

Responses

Returns a list of issue types.

application/json

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

Create an issue type from JSON representation

Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme.

Request

Request bodyapplication/json

All information about the issue type.

description

string

name

string

type

string

Responses

The new issue type has been created.

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

Get paginated list of filtered issue typesExperimental

Returns paginated list of filtered issue types

Request

Query parameters

maxResults

integer

query

string

projectIds

array<integer>

startAt

integer

Header parameters

X-Requested-With

string

Responses

Returns paginated list of issue types.

application/json

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

Get full representation of issue type by id

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

Request

Path parameters

id

string

Required

Responses

Returns the issue type with the given id.

application/json

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

Update specified issue type from JSON representation

Updates the specified issue type from a JSON representation.

Request

Path parameters

id

string

Required

Request bodyapplication/json

All information about the issue type.

avatarId

integer

description

string

name

string

Responses

Returned if the issue type was updated successfully.

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

Delete specified issue type and migrate associated issues

Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the parameter.

Request

Path parameters

id

string

Required
alternativeIssueTypeId

string

Required

Responses

Returns NO_CONTENT if successful.

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

Get list of alternative issue types for given id

Returns a list of all alternative issue types for the given issue type id.

Request

Path parameters

id

string

Required

Responses

Returns a list of issue types.

application/json

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

Convert temporary avatar into a real avatar

Converts temporary avatar into a real avatar

Request

Path parameters

id

string

Required

Request bodyapplication/json

Cropping instructions.

cropperOffsetX

integer

cropperOffsetY

integer

cropperWidth

integer

needsCropping

boolean

url

string

Responses

Returns created avatar.

application/json

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

Create temporary avatar using multipart for issue type

Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON from. Creating a temporary avatar is part of a 3-step process in uploading a new avatar for an issue type: upload, crop, confirm. This endpoint allows you to use a multipart upload instead of sending the image directly as the request body. You must use "avatar" as the name of the upload parameter: curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check"
-F "avatar=@mynewavatar.png;type=image/png"
'http://localhost:8090/jira/rest/api/2/issuetype/1/avatar/temporary'

Request

Path parameters

id

string

Required

Request bodymultipart/form-data

contentType

string

formField

boolean

inputStream

object

name

string

size

integer

value

string

Responses

Temporary avatar cropping instructions embeded in HTML page. Error messages will also be embeded in the page.

text/html

AvatarCroppingBean
POST/api/2/issuetype/{id}/avatar/temporary
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/issuetype/{id}/avatar/temporary' \ --user 'email@example.com:<api_token>' \ --header 'Accept: text/html'
GET

Get all properties keys for issue typeExperimental

Returns the keys of all properties for the issue type identified by the id

Request

Path parameters

issueTypeId

string

Required

Responses

Returns keys of all properties for the issue type.

application/json

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

Get value of specified issue type's propertyExperimental

Returns the value of the property with a given key from the issue type identified by the id

Request

Path parameters

propertyKey

string

Required
issueTypeId

string

Required

Responses

Returns the value of the property with a given key from the issue type.

application/json

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

Update specified issue type's propertyExperimental

Sets the value of the specified issue type's property

Request

Path parameters

propertyKey

string

Required
issueTypeId

string

Required

Request bodyapplication/json

The value of the issue type's property. The value has to be a valid, non-empty JSON conforming to http://tools.ietf.org/html/rfc4627. The maximum length of the property value is 32768 bytes.

id

string

key

string

value

string

Responses

Returned if the issue type property is successfully updated.

PUT/api/2/issuetype/{issueTypeId}/properties/{propertyKey}
1 2 3 4 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/issuetype/{issueTypeId}/properties/{propertyKey}' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json'
DEL

Delete specified issue type's propertyExperimental

Removes the property from the issue type identified by the id

Request

Path parameters

propertyKey

string

Required
issueTypeId

string

Required

Responses

Removes the property from the issue type.

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

Rate this page: