Module issue_custom_field_contexts_api

Enums

AddIssueTypesToContextError

struct for typed errors of method add_issue_types_to_context

AssignProjectsToCustomFieldContextError

struct for typed errors of method assign_projects_to_custom_field_context

CreateCustomFieldContextError

struct for typed errors of method create_custom_field_context

DeleteCustomFieldContextError

struct for typed errors of method delete_custom_field_context

GetContextsForFieldError

struct for typed errors of method get_contexts_for_field

GetCustomFieldContextsForProjectsAndIssueTypesError

struct for typed errors of method get_custom_field_contexts_for_projects_and_issue_types

GetDefaultValuesError

struct for typed errors of method get_default_values

GetIssueTypeMappingsForContextsError

struct for typed errors of method get_issue_type_mappings_for_contexts

GetProjectContextMappingError

struct for typed errors of method get_project_context_mapping

RemoveCustomFieldContextFromProjectsError

struct for typed errors of method remove_custom_field_context_from_projects

RemoveIssueTypesFromContextError

struct for typed errors of method remove_issue_types_from_context

SetDefaultValuesError

struct for typed errors of method set_default_values

UpdateCustomFieldContextError

struct for typed errors of method update_custom_field_context

Functions

add_issue_types_to_context

Adds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added. Permissions required: Administer Jira global permission.

assign_projects_to_custom_field_context

Assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails. Permissions required: Administer Jira global permission.

create_custom_field_context

Creates a custom field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types. Permissions required: Administer Jira global permission.

delete_custom_field_context

Deletes a custom field context. Permissions required: Administer Jira global permission.

get_contexts_for_field

Returns a paginated list of contexts for a custom field. Contexts can be returned as follows: * With no other parameters set, all contexts. * By defining id only, all contexts from the list of IDs. * By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false) * By defining isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false). Permissions required: Administer Jira global permission.

get_custom_field_contexts_for_projects_and_issue_types

Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type. If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null. Duplicate project and issue type mappings cannot be provided in the request. The order of the returned values is the same as provided in the request. Permissions required: Administer Jira global permission.

get_default_values

Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: * CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons. * CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes. * CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists. Permissions required: Administer Jira global permission.

get_issue_type_mappings_for_contexts

Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID. Permissions required: Administer Jira global permission.

get_project_context_mapping

Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId, or otherwise all mappings are returned. Invalid IDs are ignored. Permissions required: Administer Jira global permission.

remove_custom_field_context_from_projects

Removes a custom field context from projects. A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects. If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails. Permissions required: Administer Jira global permission.

remove_issue_types_from_context

Removes issue types from a custom field context. A custom field context without any issue types applies to all issue types. Permissions required: Administer Jira global permission.

set_default_values

Sets default for contexts of a custom field. Default are defined using these objects: * CustomFieldContextDefaultValueSingleOption (type option.single) for single choice select lists and radio buttons. * CustomFieldContextDefaultValueMultipleOption (type option.multiple) for multiple choice select lists and checkboxes. * CustomFieldContextDefaultValueCascadingOption (type option.cascading) for cascading select lists. Only one type of default object can be included in a request. To remove a default for a context, set the default parameter to null. Permissions required: Administer Jira global permission.

update_custom_field_context

Updates a custom field context. Permissions required: Administer Jira global permission.