Skip to content

issuetypescreenscheme

append-mappings-for-issue-type-screen-scheme

Append mappings to issue type screen scheme

Appends issue type to screen scheme mappings to an issue type screen scheme.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.

Example:

bash
jr issuetypescreenscheme append-mappings-for-issue-type-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>

assign-issue-type-screen-scheme-to-project

Assign issue type screen scheme to project

Assigns an issue type screen scheme to a project.

Issue type screen schemes can only be assigned to classic projects.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescreenscheme/project

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr issuetypescreenscheme assign-issue-type-screen-scheme-to-project

create-issue-type-screen-scheme

Create issue type screen scheme

Creates an issue type screen scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/issuetypescreenscheme

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr issuetypescreenscheme create-issue-type-screen-scheme

delete-issue-type-screen-scheme

Delete issue type screen scheme

Deletes an issue type screen scheme.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}

FlagTypeRequiredDescription
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.

Example:

bash
jr issuetypescreenscheme delete-issue-type-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>

get-issue-type-screen-scheme-mappings

Get issue type screen scheme items

Returns a paginated list of issue type screen scheme items.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescreenscheme/mapping

FlagTypeRequiredDescription
--issueTypeScreenSchemeIdstringNoThe list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001.
--maxResultsstringNoThe maximum number of items to return per page.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr issuetypescreenscheme get-issue-type-screen-scheme-mappings

get-issue-type-screen-scheme-project-associations

Get issue type screen schemes for projects

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

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescreenscheme/project

FlagTypeRequiredDescription
--maxResultsstringNoThe maximum number of items to return per page.
--projectIdstringNoThe list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr issuetypescreenscheme get-issue-type-screen-scheme-project-associations

get-issue-type-screen-schemes

Get issue type screen schemes

Returns a paginated list of issue type screen schemes.

Only issue type screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescreenscheme

FlagTypeRequiredDescription
--expandstringNoUse expand to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to.
--idstringNoThe list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
--maxResultsstringNoThe maximum number of items to return per page.
--orderBystringNoOrder the results by a field:
  • name Sorts by issue type screen scheme name.
  • id Sorts by issue type screen scheme ID. | | --queryString | string | No | String used to perform a case-insensitive partial match with issue type screen scheme name. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

bash
jr issuetypescreenscheme get-issue-type-screen-schemes

get-projects-for-issue-type-screen-scheme

Get issue type screen scheme projects

Returns a paginated list of projects associated with an issue type screen scheme.

Only company-managed projects associated with an issue type screen scheme are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project

FlagTypeRequiredDescription
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.
--maxResultsstringNoThe maximum number of items to return per page.
--querystringNo
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr issuetypescreenscheme get-projects-for-issue-type-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>

remove-mappings-from-issue-type-screen-scheme

Remove mappings from issue type screen scheme

Removes issue type to screen scheme mappings from an issue type screen scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.

Example:

bash
jr issuetypescreenscheme remove-mappings-from-issue-type-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>

update-default-screen-scheme

Update issue type screen scheme default screen scheme

Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.

Example:

bash
jr issuetypescreenscheme update-default-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>

update-issue-type-screen-scheme

Update issue type screen scheme

Updates an issue type screen scheme.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--issueTypeScreenSchemeIdstringYesThe ID of the issue type screen scheme.

Example:

bash
jr issuetypescreenscheme update-issue-type-screen-scheme --issueTypeScreenSchemeId <issueTypeScreenSchemeId>