issuetypescheme

add-issue-types-to-issue-type-scheme

Add issue types to issue type scheme

Adds issue types to an issue type scheme.

The added issue types are appended to the issue types list.

If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype

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

Example:

jr issuetypescheme add-issue-types-to-issue-type-scheme --issueTypeSchemeId <issueTypeSchemeId>

assign-issue-type-scheme-to-project

Assign issue type scheme to project

Assigns an issue type scheme to a project.

If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme.

Issue type schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescheme/project

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

Example:

jr issuetypescheme assign-issue-type-scheme-to-project

create-issue-type-scheme

Create issue type scheme

Creates an issue type scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/issuetypescheme

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

Example:

jr issuetypescheme create-issue-type-scheme

delete-issue-type-scheme

Delete issue type scheme

Deletes an issue type scheme.

Only issue type schemes used in classic projects can be deleted. Only issue type schemes not associated with a project can be deleted

A validation error will be returned if the specified scheme is associated with one or more projects. Use Get issue type scheme API (with the projects expand, and id query parameter) to get a list of projects. Then, use Assign issue type scheme to project API to associate all projects to another scheme before deleting.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/issuetypescheme/{issueTypeSchemeId}

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

Example:

jr issuetypescheme delete-issue-type-scheme --issueTypeSchemeId <issueTypeSchemeId>

get-all-issue-type-schemes

Get all issue type schemes

Returns a paginated list of issue type schemes.

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescheme

Flag	Type	Required	Description
--expand	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

• projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to.

• issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have. | | --id | string | No | The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. | | --maxResults | string | No | The maximum number of items to return per page. | | --orderBy | string | No | Order the results by a field:

• name Sorts by issue type scheme name.

• id Sorts by issue type scheme ID. | | --queryString | string | No | String used to perform a case-insensitive partial match with issue type scheme name. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

jr issuetypescheme get-all-issue-type-schemes

get-issue-type-scheme-for-projects

Get issue type schemes for projects

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

Only issue type schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescheme/project

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of items to return per page.
--projectId	string	No	The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&projectId=10001.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr issuetypescheme get-issue-type-scheme-for-projects

get-issue-type-schemes-mapping

Get issue type scheme items

Returns a paginated list of issue type scheme items.

Only issue type scheme items used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescheme/mapping

Flag	Type	Required	Description
--issueTypeSchemeId	string	No	The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&issueTypeSchemeId=10001.
--maxResults	string	No	The maximum number of items to return per page.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr issuetypescheme get-issue-type-schemes-mapping

remove-issue-type-from-issue-type-scheme

Remove issue type from issue type scheme

Removes an issue type from an issue type scheme.

This operation cannot remove:

• any issue type used by issues.
• any issue types from the default issue type scheme.
• the last standard issue type from an issue type scheme.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}

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

Example:

jr issuetypescheme remove-issue-type-from-issue-type-scheme --issueTypeId <issueTypeId> --issueTypeSchemeId <issueTypeSchemeId>

reorder-issue-types-in-issue-type-scheme

Change order of issue types

Changes the order of issue types in an issue type scheme.

The request body parameters must meet the following requirements:

• all of the issue types must belong to the issue type scheme.
• either after or position must be provided.
• the issue type in after must not be in the issue type list.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move

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

Example:

jr issuetypescheme reorder-issue-types-in-issue-type-scheme --issueTypeSchemeId <issueTypeSchemeId>

update-issue-type-scheme

Update issue type scheme

Updates an issue type scheme.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescheme/{issueTypeSchemeId}

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

Example:

jr issuetypescheme update-issue-type-scheme --issueTypeSchemeId <issueTypeSchemeId>