screens

add-field-to-default

Add field to default screen

Adds a field to the default tab of the default screen.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens/addToDefault/{fieldId}

Flag	Type	Required	Description
--fieldId	string	Yes	The ID of the field.

Example:

jr screens add-field-to-default --fieldId <fieldId>

add-tab

Create screen tab

Creates a tab for a screen.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens/{screenId}/tabs

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

Example:

jr screens add-tab --screenId <screenId>

add-tab-field

Add screen tab field

Adds a field to a screen tab.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields

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

Example:

jr screens add-tab-field --screenId <screenId> --tabId <tabId>

create

Create screen

Creates a screen with a default field tab.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens

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

Example:

jr screens create

delete

Delete screen

Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft.

Only screens used in classic projects can be deleted.

DELETE /rest/api/3/screens/{screenId}

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

Example:

jr screens delete --screenId <screenId>

delete-tab

Delete screen tab

Deletes a screen tab.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/screens/{screenId}/tabs/{tabId}

Flag	Type	Required	Description
--screenId	string	Yes	The ID of the screen.
--tabId	string	Yes	The ID of the screen tab.

Example:

jr screens delete-tab --screenId <screenId> --tabId <tabId>

get

Get screens

Returns a paginated list of all screens or those specified by one or more screen IDs.

Permissions required: Administer Jira global permission.

GET /rest/api/3/screens

Flag	Type	Required	Description
--id	string	No	The list of screen 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 ID.
• name Sorts by screen name. | | --queryString | string | No | String used to perform a case-insensitive partial match with screen name. | | --scope | string | No | The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

jr screens get

get-all-screen-tab-fields

Get all screen tab fields

Returns all fields for a screen tab.

Permissions required:

• Administer Jira global permission.
• Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

GET /rest/api/3/screens/{screenId}/tabs/{tabId}/fields

Flag	Type	Required	Description
--projectKey	string	No	The key of the project.
--screenId	string	Yes	The ID of the screen.
--tabId	string	Yes	The ID of the screen tab.

Example:

jr screens get-all-screen-tab-fields --screenId <screenId> --tabId <tabId>

get-all-screen-tabs

Get all screen tabs

Returns the list of tabs for a screen.

Permissions required:

• Administer Jira global permission.
• Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.

GET /rest/api/3/screens/{screenId}/tabs

Flag	Type	Required	Description
--projectKey	string	No	The key of the project.
--screenId	string	Yes	The ID of the screen.

Example:

jr screens get-all-screen-tabs --screenId <screenId>

get-available-screen-fields

Get available screen fields

Returns the fields that can be added to a tab on a screen.

Permissions required: Administer Jira global permission.

GET /rest/api/3/screens/{screenId}/availableFields

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

Example:

jr screens get-available-screen-fields --screenId <screenId>

get-bulk-screen-tabs

Get bulk screen tabs

Returns the list of tabs for a bulk of screens.

Permissions required:

• Administer Jira global permission.

GET /rest/api/3/screens/tabs

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

Example:

jr screens get-bulk-screen-tabs

move-tab

Move screen tab

Moves a screen tab.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}

Flag	Type	Required	Description
--pos	string	Yes	The position of tab. The base index is 0.
--screenId	string	Yes	The ID of the screen.
--tabId	string	Yes	The ID of the screen tab.

Example:

jr screens move-tab --pos <pos> --screenId <screenId> --tabId <tabId>

move-tab-field

Move screen tab field

Moves a screen tab field.

If after and position are provided in the request, position is ignored.

Permissions required: Administer Jira global permission.

POST /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--id	string	Yes	The ID of the field.
--screenId	string	Yes	The ID of the screen.
--tabId	string	Yes	The ID of the screen tab.

Example:

jr screens move-tab-field --id <id> --screenId <screenId> --tabId <tabId>

remove-tab-field

Remove screen tab field

Removes a field from a screen tab.

Permissions required: Administer Jira global permission.

DELETE /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}

Flag	Type	Required	Description
--id	string	Yes	The ID of the field.
--screenId	string	Yes	The ID of the screen.
--tabId	string	Yes	The ID of the screen tab.

Example:

jr screens remove-tab-field --id <id> --screenId <screenId> --tabId <tabId>

rename-tab

Update screen tab

Updates the name of a screen tab.

Permissions required: Administer Jira global permission.

PUT /rest/api/3/screens/{screenId}/tabs/{tabId}

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

Example:

jr screens rename-tab --screenId <screenId> --tabId <tabId>

update

Update screen

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

Permissions required: Administer Jira global permission.

PUT /rest/api/3/screens/{screenId}

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

Example:

jr screens update --screenId <screenId>