Module screens_api

Enums

AddFieldToDefaultScreenError

struct for typed errors of method add_field_to_default_screen

CreateScreenError

struct for typed errors of method create_screen

DeleteScreenError

struct for typed errors of method delete_screen

GetAvailableScreenFieldsError

struct for typed errors of method get_available_screen_fields

GetScreensError

struct for typed errors of method get_screens

GetScreensForFieldError

struct for typed errors of method get_screens_for_field

UpdateScreenError

struct for typed errors of method update_screen

Functions

add_field_to_default_screen

Adds a field to the default tab of the default screen. Permissions required: Administer Jira global permission.

create_screen

Creates a screen with a default field tab. Permissions required: Administer Jira global permission.

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.

get_available_screen_fields

Returns the fields that can be added to a tab on a screen. Permissions required: Administer Jira global permission.

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_screens_for_field

Returns a paginated list of the screens a field is used in. Permissions required: Administer Jira global permission.

update_screen

Updates a screen. Only screens used in classic projects can be updated. Permissions required: Administer Jira global permission.