issuetype

create-issue-type

Create issue type

Creates an issue type.

Permissions required: Administer Jira global permission.

POST /rest/api/3/issuetype

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr issuetype create-issue-type

create-issue-type-avatar

Load issue type avatar

Loads an avatar for the issue type.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

• X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.
• Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:
curl --request POST \ --user email@example.com:<api_token> \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar, use Update issue type to set it as the issue type's displayed avatar.

Permissions required: Administer Jira global permission.

POST /rest/api/3/issuetype/{id}/avatar2

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the issue type.
--size	string	No	The length of each side of the crop region.
--x	string	No	The X coordinate of the top-left corner of the crop region.
--y	string	No	The Y coordinate of the top-left corner of the crop region.

Example:

jr issuetype create-issue-type-avatar --id <id>

delete-issue-type

Delete issue type

Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the Get alternative issue types resource.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/issuetype/{id}

Flag	Type	Required	Description
--alternativeIssueTypeId	string	No	The ID of the replacement issue type.
--id	string	Yes	The ID of the issue type.

Example:

jr issuetype delete-issue-type --id <id>

delete-issue-type-property

Delete issue type property

Deletes the issue type property.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

Flag	Type	Required	Description
--issueTypeId	string	Yes	The ID of the issue type.
--propertyKey	string	Yes	The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

Example:

jr issuetype delete-issue-type-property --issueTypeId <issueTypeId> --propertyKey <propertyKey>

get-alternative-issue-types

Get alternative issue types

Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.

This operation can be accessed anonymously.

Permissions required: None.

GET /rest/api/3/issuetype/{id}/alternatives

Flag	Type	Required	Description
--id	string	Yes	The ID of the issue type.

Example:

jr issuetype get-alternative-issue-types --id <id>

get-issue-all-types

Get all issue types for user

Returns all issue types.

This operation can be accessed anonymously.

Permissions required: Issue types are only returned as follows:

• if the user has the Administer Jira global permission, all issue types are returned.
• if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
• if the user is anonymous then they will be able to access projects with the Browse projects for anonymous users
• if the user authentication is incorrect they will fall back to anonymous

GET /rest/api/3/issuetype

Example:

jr issuetype get-issue-all-types

get-issue-type

Get issue type

Returns an issue type.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.

GET /rest/api/3/issuetype/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the issue type.

Example:

jr issuetype get-issue-type --id <id>

get-issue-type-property

Get issue type property

Returns the key and value of the issue type property.

This operation can be accessed anonymously.

Permissions required:

• Administer Jira global permission to get the details of any issue type.
• Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.

GET /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

Flag	Type	Required	Description
--issueTypeId	string	Yes	The ID of the issue type.
--propertyKey	string	Yes	The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

Example:

jr issuetype get-issue-type-property --issueTypeId <issueTypeId> --propertyKey <propertyKey>

get-issue-type-property-keys

Get issue type property keys

Returns all the issue type property keys of the issue type.

This operation can be accessed anonymously.

Permissions required:

• Administer Jira global permission to get the property keys of any issue type.
• Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.

GET /rest/api/3/issuetype/{issueTypeId}/properties

Flag	Type	Required	Description
--issueTypeId	string	Yes	The ID of the issue type.

Example:

jr issuetype get-issue-type-property-keys --issueTypeId <issueTypeId>

get-issue-types-for-project

Get issue types for project

Returns issue types for a project.

This operation can be accessed anonymously.

Permissions required: Browse projects project permission in the relevant project or Administer Jira global permission.

GET /rest/api/3/issuetype/project

Flag	Type	Required	Description
--level	string	No	The level of the issue type to filter by. Use:

• -1 for Subtask.
• 0 for Base.
• 1 for Epic. | | --projectId | string | No | The ID of the project. |

Example:

jr issuetype get-issue-types-for-project

set-issue-type-property

Set issue type property

Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--issueTypeId	string	Yes	The ID of the issue type.
--propertyKey	string	Yes	The key of the issue type property. The maximum length is 255 characters.

Example:

jr issuetype set-issue-type-property --issueTypeId <issueTypeId> --propertyKey <propertyKey>

update-issue-type

Update issue type

Updates the issue type.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetype/{id}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the issue type.

Example:

jr issuetype update-issue-type --id <id>