Module issue_fields_api

Source

Enums§

CreateCustomFieldError
struct for typed errors of method create_custom_field
DeleteCustomFieldError
struct for typed errors of method delete_custom_field
GetContextsForFieldDeprecatedError
struct for typed errors of method get_contexts_for_field_deprecated
GetFieldsError
struct for typed errors of method get_fields
GetFieldsPaginatedError
struct for typed errors of method get_fields_paginated
GetTrashedFieldsPaginatedError
struct for typed errors of method get_trashed_fields_paginated
RestoreCustomFieldError
struct for typed errors of method restore_custom_field
TrashCustomFieldError
struct for typed errors of method trash_custom_field
UpdateCustomFieldError
struct for typed errors of method update_custom_field

Functions§

create_custom_field
Creates a custom field. Permissions required: Administer Jira global permission.
delete_custom_field
Deletes a custom field. The custom field is deleted whether it is in the trash or not. See Edit or delete a custom field for more information on trashing and deleting custom fields. This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates. Permissions required: Administer Jira global permission.
get_contexts_for_field_deprecated
Returns a paginated list of the contexts a field is used in. Deprecated, use Get custom field contexts. Permissions required: Administer Jira global permission.
get_fields
Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue navigator are always returned. * Fields that cannot be placed on an issue screen are always returned. * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches. * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.) This operation can be accessed anonymously. Permissions required: None.
get_fields_paginated
Returns a paginated list of fields for Classic Jira projects. The list can include: * all fields * specific fields, by defining id * fields that contain a string in the field name or description, by defining query * specific fields that contain a string in the field name or description, by defining id and query Use type must be set to custom to show custom fields only. Permissions required: Permission to access Jira.
get_trashed_fields_paginated
Returns a paginated list of fields in the trash. The list may be restricted to fields whose field name or description partially match a string. Only custom fields can be queried, type must be set to custom. Permissions required: Administer Jira global permission.
restore_custom_field
Restores a custom field from trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. Permissions required: Administer Jira global permission.
trash_custom_field
Moves a custom field to trash. See Edit or delete a custom field for more information on trashing and deleting custom fields. Permissions required: Administer Jira global permission.
update_custom_field
Updates a custom field. Permissions required: Administer Jira global permission.