screenscheme

create-screen-scheme

Create screen scheme

Creates a screen scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screenscheme

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

Example:

jr screenscheme create-screen-scheme

delete-screen-scheme

Delete screen scheme

Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme.

Only screens schemes used in classic projects can be deleted.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/screenscheme/{screenSchemeId}

Flag	Type	Required	Description
--screenSchemeId	string	Yes	The ID of the screen scheme.

Example:

jr screenscheme delete-screen-scheme --screenSchemeId <screenSchemeId>

get-screen-schemes

Get screen schemes

Returns a paginated list of screen schemes.

Only screen schemes used in classic projects are returned.

Permissions required: Administer Jira global permission.

GET /rest/api/3/screenscheme

Flag	Type	Required	Description
--expand	string	No	Use expand include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to.
--id	string	No	The list of screen scheme 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:

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

Example:

jr screenscheme get-screen-schemes

update-screen-scheme

Update screen scheme

Updates a screen scheme. Only screen schemes used in classic projects can be updated.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/screenscheme/{screenSchemeId}

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

Example:

jr screenscheme update-screen-scheme --screenSchemeId <screenSchemeId>