Module issue_custom_field_options_apps_api

Enums

CreateIssueFieldOptionError

struct for typed errors of method create_issue_field_option

DeleteIssueFieldOptionError

struct for typed errors of method delete_issue_field_option

GetAllIssueFieldOptionsError

struct for typed errors of method get_all_issue_field_options

GetIssueFieldOptionError

struct for typed errors of method get_issue_field_option

GetSelectableIssueFieldOptionsError

struct for typed errors of method get_selectable_issue_field_options

GetVisibleIssueFieldOptionsError

struct for typed errors of method get_visible_issue_field_options

ReplaceIssueFieldOptionError

struct for typed errors of method replace_issue_field_option

UpdateIssueFieldOptionError

struct for typed errors of method update_issue_field_option

Functions

create_issue_field_option

Creates an option for a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

delete_issue_field_option

Deletes an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

get_all_issue_field_options

Returns a paginated list of all the options of a select list issue field. A select list issue field is a type of issue field that enables a user to select a value from a list of options. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

get_issue_field_option

Returns an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

get_selectable_issue_field_options

Returns a paginated list of options for a select list issue field that can be viewed and selected by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Permission to access Jira.

get_visible_issue_field_options

Returns a paginated list of options for a select list issue field that can be viewed by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Permission to access Jira.

replace_issue_field_option

Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an asynchronous operation. The response object contains a link to the long-running task. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.

update_issue_field_option

Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource. Permissions required: Administer Jira global permission. Jira permissions are not required for the app providing the field.