Module issue_custom_field_options_api

Module issue_custom_field_options_api 

Source

Enums§

CreateCustomFieldOptionError
struct for typed errors of method create_custom_field_option
CreateCustomFieldOptionsError
struct for typed errors of method create_custom_field_options
DeleteCustomFieldOptionError
struct for typed errors of method delete_custom_field_option
GetCustomFieldOptionError
struct for typed errors of method get_custom_field_option
GetOptionsForContextError
struct for typed errors of method get_options_for_context
GetOptionsForFieldError
struct for typed errors of method get_options_for_field
ReorderCustomFieldOptionsError
struct for typed errors of method reorder_custom_field_options
UpdateCustomFieldOptionError
struct for typed errors of method update_custom_field_option
UpdateCustomFieldOptionsError
struct for typed errors of method update_custom_field_options

Functions§

create_custom_field_option
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.
create_custom_field_options
This operation is deprecated and becomes unavailable on 8 May 2021. Use Create custom field options (context) instead. See Deprecation of custom field options for details. Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to the global context of the field. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps. Permissions required: Administer Jira global permission.
delete_custom_field_option
Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.
get_custom_field_option
This operation is deprecated and becomes unavailable on 8 May 2021. Use Get custom field options (context) instead. See Deprecation of custom field options for details. Returns a custom field option. For example, an option in a select list. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps. This operation can be accessed anonymously. Permissions required: The custom field option is returned as follows: * if the user has the Administer Jira global permission. * if the user has the Browse projects project permission for at least one project the custom field is used in, and the field is visible in at least one layout the user has permission to view.
get_options_for_context
Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.
get_options_for_field
This operation is deprecated and becomes unavailable on 8 May 2021. Use Get custom field options (context) instead. See Deprecation of custom field options for details. Returns a paginated list of options and, where the custom select field is of the type Select List (cascading), cascading options for custom select fields. Cascading options are included in the item count when determining pagination. Only options from the global context are returned. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps. Permissions required: Administer Jira global permission.
reorder_custom_field_options
Changes the order of custom field options or cascading options in a context. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations. Permissions required: Administer Jira global permission.
update_custom_field_option
Updates the options of a custom field. If any of the options are not found, no options are updated. Options where the values in the request match the current values aren’t updated and aren’t reported in the response. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps. Permissions required: Administer Jira global permission.
update_custom_field_options
This operation is deprecated and becomes unavailable on 8 May 2021. Use Update custom field options (context) instead. See Deprecation of custom field options for details. Updates the options on a custom select field. Where an updated option is in use on an issue, the value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including sub-options of Select List (cascading) fields, can be updated per request. The options are updated on the global context of the field. Note that this operation only works for issue field select list options created in Jira or using operations from the Issue custom field options resource, it cannot be used with issue field select list options created by Connect apps. Permissions required: Administer Jira global permission.