openapi: 3.2.0 info: contact: email: ecosystem@atlassian.com description: Jira Cloud platform REST API documentation license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/ title: Jira Cloud platform REST Issue custom field contexts API version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df servers: - url: https://your-domain.atlassian.net tags: - description: 'This resource represents issue custom field contexts. Use it to: * get, create, update, and delete custom field contexts. * get context to issue types and projects mappings. * get custom field contexts for projects and issue types. * assign custom field contexts to projects. * remove custom field contexts from projects. * add issue types to custom field contexts.' name: Issue Custom Field Contexts paths: /rest/api/3/field/{fieldId}/context: get: deprecated: false description: '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. *Edit Workflow* edit workflow permission' operationId: getContextsForField parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: Whether to return contexts that apply to all issue types. in: query name: isAnyIssueType schema: type: boolean - description: Whether to return contexts that apply to all projects. in: query name: isGlobalContext schema: type: boolean - description: 'The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`.' in: query name: contextId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":100,"startAt":0,"total":2,"values":[{"id":"10025","name":"Bug fields context","description":"A context used to define the custom field options for bugs.","isGlobalContext":true,"isAnyIssueType":false},{"id":"10026","name":"Task fields context","description":"A context used to define the custom field options for tasks.","isGlobalContext":false,"isAnyIssueType":false}]}' schema: $ref: '#/components/schemas/PageBeanCustomFieldContext' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The custom field was not found."],"errors":{}}' description: Returned if the custom field was not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get custom field contexts tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field:jira - read:custom-field-contextual-configuration:jira state: Beta x-atlassian-connect-scope: READ post: deprecated: false description: '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.' operationId: createCustomFieldContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string requestBody: content: application/json: example: description: A context used to define the custom field options for bugs. issueTypeIds: - '10010' name: Bug fields context projectIds: [] schema: $ref: '#/components/schemas/CreateCustomFieldContext' required: true responses: '201': content: application/json: example: '{"id":"10025","name":"Bug fields context","description":"A context used to define the custom field options for bugs.","projectIds":[],"issueTypeIds":["10010"]}' schema: $ref: '#/components/schemas/CreateCustomFieldContext' description: Returned if the custom field context is created. '400': description: Returned if the request is invalid. '401': description: Returned if the authentication credentials are incorrect or missing. '404': description: Returned if the field, project, or issue type is not found. '409': content: application/json: example: '{"errorMessages":["Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task."],"errors":{}}' description: Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Create custom field context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field:jira - write:field:jira - read:custom-field-contextual-configuration:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/defaultValue: get: deprecated: true description: '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: * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields. * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields. * `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. * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users. * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists. * `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group pickers. * `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group pickers. * `CustomFieldContextDefaultValueURL` (type `url`) for URLs. * `CustomFieldContextDefaultValueProject` (type `project`) for project pickers. * `CustomFieldContextDefaultValueFloat` (type `float`) for floats (floating-point numbers). * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels. * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text fields. * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area fields. * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) fields. * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version pickers. * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version pickers. Forge custom fields types are also supported, returning: * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`) for Forge string fields. * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type `forge.string.list`) for Forge string collection fields. * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`) for Forge object fields. * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type `forge.datetime`) for Forge date-time fields. * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`) for Forge group fields. * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type `forge.group.list`) for Forge group collection fields. * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`) for Forge number fields. * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for Forge user fields. * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type `forge.user.list`) for Forge user collection fields. **Deprecated:** This API is deprecated and will be removed in October 2026. A replacement API that supports multiple default values per issue type within a context is coming soon. See the deprecation notice CHANGE-3082 for more details. **Permissions required:** *Administer Jira* global permission.' operationId: getDefaultValues parameters: - description: The ID of the custom field, for example `customfield\_10000`. in: path name: fieldId required: true schema: type: string - description: The IDs of the contexts. in: query name: contextId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"contextId":"10100","optionId":"10001"},{"contextId":"10101","optionId":"10003"},{"contextId":"10103"}]}' schema: $ref: '#/components/schemas/PageBeanCustomFieldContextDefaultValue' description: Returned if the request is successful. '400': description: Returned if one or more of the field's contexts have different default values per issue type, which this endpoint cannot represent. Use `GET /rest/api/3/field/{fieldId}/context/defaultvalues` instead. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The custom field was not found."],"errors":{}}' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get custom field contexts default values tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field.default-value:jira state: Beta x-changes: - announced: '2026-03-05' details: https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3082 effective: '2026-10-01' type: removed x-atlassian-connect-scope: READ put: deprecated: true description: 'Sets default for contexts of a custom field. Default are defined using these objects: * `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields. * `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields. * `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. * `CustomFieldContextSingleUserPickerDefaults` (type `single.user.select`) for single users. * `CustomFieldContextDefaultValueMultiUserPicker` (type `multi.user.select`) for user lists. * `CustomFieldContextDefaultValueSingleGroupPicker` (type `grouppicker.single`) for single choice group pickers. * `CustomFieldContextDefaultValueMultipleGroupPicker` (type `grouppicker.multiple`) for multiple choice group pickers. * `CustomFieldContextDefaultValueURL` (type `url`) for URLs. * `CustomFieldContextDefaultValueProject` (type `project`) for project pickers. * `CustomFieldContextDefaultValueFloat` (type `float`) for floats (floating-point numbers). * `CustomFieldContextDefaultValueLabels` (type `labels`) for labels. * `CustomFieldContextDefaultValueTextField` (type `textfield`) for text fields. * `CustomFieldContextDefaultValueTextArea` (type `textarea`) for text area fields. * `CustomFieldContextDefaultValueReadOnly` (type `readonly`) for read only (text) fields. * `CustomFieldContextDefaultValueMultipleVersion` (type `version.multiple`) for single choice version pickers. * `CustomFieldContextDefaultValueSingleVersion` (type `version.single`) for multiple choice version pickers. Forge custom fields types are also supported, returning: * `CustomFieldContextDefaultValueForgeStringFieldBean` (type `forge.string`) for Forge string fields. * `CustomFieldContextDefaultValueForgeMultiStringFieldBean` (type `forge.string.list`) for Forge string collection fields. * `CustomFieldContextDefaultValueForgeObjectFieldBean` (type `forge.object`) for Forge object fields. * `CustomFieldContextDefaultValueForgeDateTimeFieldBean` (type `forge.datetime`) for Forge date-time fields. * `CustomFieldContextDefaultValueForgeGroupFieldBean` (type `forge.group`) for Forge group fields. * `CustomFieldContextDefaultValueForgeMultiGroupFieldBean` (type `forge.group.list`) for Forge group collection fields. * `CustomFieldContextDefaultValueForgeNumberFieldBean` (type `forge.number`) for Forge number fields. * `CustomFieldContextDefaultValueForgeUserFieldBean` (type `forge.user`) for Forge user fields. * `CustomFieldContextDefaultValueForgeMultiUserFieldBean` (type `forge.user.list`) for Forge user collection fields. 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`. **Deprecated:** This API is deprecated and will be removed in October 2026. A replacement API that supports multiple default values per issue type within a context is coming soon. See the deprecation notice CHANGE-3082 for more details. **Permissions required:** *Administer Jira* global permission.' operationId: setDefaultValues parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string requestBody: content: application/json: example: defaultValues: - contextId: '10100' optionId: '10001' type: option.single - contextId: '10101' optionId: '10003' type: option.single - contextId: '10103' optionId: '10005' type: option.single schema: $ref: '#/components/schemas/CustomFieldContextDefaultValueUpdate' required: true responses: '204': content: application/json: schema: {} description: Returned if operation is successful. '400': content: application/json: example: '{"errorMessages":["All default values in the request must have the same type."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field, a context, an option, or a cascading option is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Set custom field contexts default values tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field.default-value:jira state: Beta x-changes: - announced: '2026-03-05' details: https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3082 effective: '2026-10-01' type: removed x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/defaultValues: get: deprecated: false description: 'Returns a paginated list of default values grouped by custom field context. Each returned `ContextDefaultValuesBean` has a `contextId` and a `defaultValues` list of `IssueTypeDefaultValueBean` entries - one per issue-type-scoped default value configured for the context. An entry with `"isAnyIssueType": true` represents the catch-all default that applies to every issue type covered by the context that is not covered by a more specific entry; a non-null `issueTypeId` represents a default that only applies to that issue type. For contexts that have not been converted to the multiple-contexts data model, exactly one entry is returned per context with `isAnyIssueType=true`. For converted contexts, one entry is returned per configured per-issue-type default. The value object on each entry is the same polymorphic `CustomFieldContextDefaultValueBean` exposed by the deprecated `GET /defaultValue` endpoint - its concrete subtype depends on the custom field''s type (see the list of supported types on that endpoint). **Permissions required:** *Administer Jira* global permission.' operationId: getContextDefaultValues parameters: - description: The ID of the custom field, for example `customfield\_10000`. in: path name: fieldId required: true schema: type: string - description: The IDs of the contexts to return default values for. If omitted, default values for every context the custom field has are returned. in: query name: contextId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The IDs of the issue types to restrict the returned per-issue-type default values to. If omitted, default values for every issue type are returned. This filter never removes the catch-all `isAnyIssueType` entry of a context. in: query name: issueTypeId schema: items: default: '' type: string type: array uniqueItems: true - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/PageBeanContextDefaultValues' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The custom field was not found."],"errors":{}}' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get default values for a custom field grouped by context and issue type tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field.default-value:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/field/{fieldId}/context/issuetypemapping: get: deprecated: false description: '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.' operationId: getIssueTypeMappingsForContexts parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, `contextId=10001&contextId=10002`. in: query name: contextId schema: items: format: int64 type: integer type: array - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":100,"startAt":0,"total":3,"values":[{"contextId":"10001","issueTypeId":"10010"},{"contextId":"10001","issueTypeId":"10011"},{"contextId":"10002","isAnyIssueType":true}]}' schema: $ref: '#/components/schemas/PageBeanIssueTypeToContextMapping' description: Returned if operation is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get issue types for custom field context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/field/{fieldId}/context/mapping: post: deprecated: false description: '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.' operationId: getCustomFieldContextsForProjectsAndIssueTypes parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer requestBody: content: application/json: example: mappings: - issueTypeId: '10000' projectId: '10000' - issueTypeId: '10001' projectId: '10000' - issueTypeId: '10002' projectId: '10001' schema: $ref: '#/components/schemas/ProjectIssueTypeMappings' description: The list of project and issue type mappings. required: true responses: '200': content: application/json: example: '{"isLast":true,"maxResults":50,"startAt":0,"total":3,"values":[{"projectId":"10000","issueTypeId":"10000","contextId":"10000"},{"projectId":"10000","issueTypeId":"10001","contextId":null},{"projectId":"10001","issueTypeId":"10002","contextId":"10003"}]}' schema: $ref: '#/components/schemas/PageBeanContextForProjectAndIssueType' description: Returned if the request is successful. '400': content: application/json: example: '{"errorMessages":["Duplicate project and issue type mappings cannot be provided."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["These projects were not found: 10005."],"errors":{}}' description: Returned if the custom field, project, or issue type is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get custom field contexts for projects and issue types tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/projectmapping: get: deprecated: false description: 'Returns a paginated list of context to project mappings for a custom field. The result can be filtered by `contextId`. Otherwise, all mappings are returned. Invalid IDs are ignored. **Note:** Jira is adding support for multiple field contexts per project. On sites where this is enabled, a custom field can have more than one context associated with the same project, so this operation can return several mappings that share the same `projectId`, each with a different `contextId`. Do not assume that a project appears at most once in the response. See CHANGE-3082 for more details. **Permissions required:** *Administer Jira* global permission.' operationId: getProjectContextMapping parameters: - description: The ID of the custom field, for example `customfield\_10000`. in: path name: fieldId required: true schema: type: string - description: 'The list of context IDs. To include multiple context, separate IDs with ampersand: `contextId=10000&contextId=10001`.' in: query name: contextId schema: items: format: int64 type: integer type: array uniqueItems: true - description: The index of the first item to return in a page of results (page offset). in: query name: startAt schema: default: 0 format: int64 type: integer - description: The maximum number of items to return per page. in: query name: maxResults schema: default: 50 format: int32 type: integer responses: '200': content: application/json: example: '{"isLast":true,"maxResults":100,"startAt":0,"total":2,"values":[{"contextId":"10025","projectId":"10001"},{"contextId":"10026","isGlobalContext":true}]}' schema: $ref: '#/components/schemas/PageBeanCustomFieldContextProjectMapping' description: Returned if the request is successful. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The custom field was not found."],"errors":{}}' description: Returned if the custom field is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Get project mappings for custom field context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - read:field:jira state: Beta x-atlassian-connect-scope: READ /rest/api/3/field/{fieldId}/context/{contextId}: delete: deprecated: false description: 'Deletes a custom field context. This API will not allow removing the global context from April 2026. Instead, an HTTP 400 response will be returned. See CHANGE-3019 **Permissions required:** *Administer Jira* global permission.' operationId: deleteCustomFieldContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer responses: '204': content: application/json: schema: {} description: Returned if the context is deleted. '400': content: application/json: example: '{"errorMessages":["The contextId has to be provided."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field or the context is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Delete custom field context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - delete:field:jira state: Beta x-atlassian-connect-scope: ADMIN put: deprecated: false description: 'Updates a custom field context. **Permissions required:** *Administer Jira* global permission.' operationId: updateCustomFieldContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer requestBody: content: application/json: example: description: A context used to define the custom field options for bugs. name: Bug fields context schema: $ref: '#/components/schemas/CustomFieldContextUpdateDetails' required: true responses: '204': content: application/json: schema: {} description: Returned if the context is updated. '400': content: application/json: example: '{"errorMessages":["The contextId has to be provided."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field or the context is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Update custom field context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/{contextId}/issuetype: put: deprecated: false description: '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. This API will not allow adding issue types to the global context from April 2026. Instead, an HTTP 400 response will be returned. See CHANGE-3019 **Permissions required:** *Administer Jira* global permission.' operationId: addIssueTypesToContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer requestBody: content: application/json: example: issueTypeIds: - '10001' - '10005' - '10006' schema: $ref: '#/components/schemas/IssueTypeIds' required: true responses: '204': content: application/json: schema: {} description: Returned if operation is successful. '400': content: application/json: example: '{"errorMessages":["These issue types are already associated with the context: 10001."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field, context, or one or more issue types are not found. '409': content: application/json: example: '{"errorMessages":["Sub-tasks are disabled in Jira. At least one of the issue types is a sub-task."],"errors":{}}' description: Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Add issue types to context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove: post: deprecated: false description: '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.' operationId: removeIssueTypesFromContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer requestBody: content: application/json: example: issueTypeIds: - '10001' - '10005' - '10006' schema: $ref: '#/components/schemas/IssueTypeIds' required: true responses: '204': content: application/json: schema: {} description: Returned if operation is successful. '400': content: application/json: example: '{"errorMessages":["These issue types are not associated with the context: 10002."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field, context, or one or more issue types are not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Remove issue types from context tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/{contextId}/project: put: deprecated: false description: '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. This API will not allow adding projects to the global context from April 2026. Instead, an HTTP 400 response will be returned. See CHANGE-3019 **Permissions required:** *Administer Jira* global permission.' operationId: assignProjectsToCustomFieldContext parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer requestBody: content: application/json: example: projectIds: - '10001' - '10005' - '10006' schema: $ref: '#/components/schemas/ProjectIds' required: true responses: '204': content: application/json: schema: {} description: Returned if operation is successful. '400': content: application/json: example: '{"errorMessages":["The projectIds must not contain duplicates."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field, context, or project is not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Assign custom field context to projects tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN /rest/api/3/field/{fieldId}/context/{contextId}/project/remove: post: deprecated: false description: '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.' operationId: removeCustomFieldContextFromProjects parameters: - description: The ID of the custom field. in: path name: fieldId required: true schema: type: string - description: The ID of the context. in: path name: contextId required: true schema: format: int64 type: integer requestBody: content: application/json: example: projectIds: - '10001' - '10005' - '10006' schema: $ref: '#/components/schemas/ProjectIds' required: true responses: '204': content: application/json: schema: {} description: Returned if the custom field context is removed from the projects. '400': content: application/json: example: '{"errorMessages":["The projectIds must not contain duplicates."],"errors":{}}' description: Returned if the request is not valid. '401': description: Returned if the authentication credentials are incorrect or missing. '403': content: application/json: example: '{"errorMessages":["Only Jira administrators can access custom field contexts."],"errors":{}}' description: Returned if the user does not have the required permissions. '404': content: application/json: example: '{"errorMessages":["The context was not found."],"errors":{}}' description: Returned if the custom field, context, or one or more projects are not found. security: - basicAuth: [] - OAuth2: - manage:jira-configuration summary: Remove custom field context from projects tags: - Issue Custom Field Contexts x-atlassian-data-security-policy: - app-access-rule-exempt: true x-atlassian-oauth2-scopes: - scheme: OAuth2 scopes: - manage:jira-configuration state: Current - scheme: OAuth2 scopes: - write:field:jira state: Beta x-atlassian-connect-scope: ADMIN components: schemas: CustomFieldContextDefaultValueReadOnly: description: The default text for a read only custom field. properties: contextId: description: The ID of the context. type: string text: description: The default text. The maximum length is 255 characters. type: string type: type: string required: - contextId - type type: object CustomFieldContextDefaultValueMultiUserPicker: description: The default value for a User Picker (multiple) custom field. properties: accountIds: description: The IDs of the default users. items: description: The IDs of the default users. type: string type: array contextId: description: The ID of the context. type: string type: type: string required: - accountIds - contextId - type type: object PageBeanCustomFieldContextProjectMapping: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/CustomFieldContextProjectMapping' readOnly: true type: array type: object CustomFieldContextDefaultValueForgeGroupField: description: The default value for a Forge group custom field. properties: contextId: description: The ID of the context. type: string groupId: description: The ID of the the default group. type: string type: type: string required: - contextId - groupId - type type: object IssueTypeToContextMapping: additionalProperties: false description: Mapping of an issue type to a context. properties: contextId: description: The ID of the context. type: string isAnyIssueType: description: Whether the context is mapped to any issue type. type: boolean issueTypeId: description: The ID of the issue type. type: string required: - contextId type: object ContextDefaultValues: additionalProperties: false description: Default values grouped by custom field context. properties: contextId: description: The ID of the context. format: int64 type: integer defaultValues: description: Per-issue-type default values for this context. May contain a single entry for unconverted contexts, or one entry per issue type for converted contexts. items: $ref: '#/components/schemas/IssueTypeDefaultValue' type: array required: - contextId type: object CustomFieldContextDefaultValueLabels: description: Default value for a labels custom field. properties: contextId: description: The ID of the context. type: string labels: description: The default labels value. items: description: The default labels value. type: string type: array type: type: string required: - contextId - labels - type type: object CustomFieldContextDefaultValueDate: description: The default value for a Date custom field. properties: contextId: description: The ID of the context. type: string date: description: The default date in ISO format. Ignored if `useCurrent` is true. type: string type: type: string useCurrent: default: false description: Whether to use the current date. type: boolean required: - contextId - type type: object CustomFieldContextDefaultValueForgeMultiStringField: description: The default text for a Forge collection of strings custom field. properties: contextId: description: The ID of the context. type: string type: type: string values: description: List of string values. The maximum length for a value is 254 characters. items: description: List of string values. The maximum length for a value is 254 characters. type: string type: array required: - contextId - type type: object ProjectIssueTypeMapping: additionalProperties: false description: The project and issue type mapping. properties: issueTypeId: description: The ID of the issue type. type: string writeOnly: true projectId: description: The ID of the project. type: string writeOnly: true required: - issueTypeId - projectId type: object writeOnly: true UserFilter: description: Filter for a User Picker (single) custom field. properties: enabled: description: Whether the filter is enabled. type: boolean groups: description: User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided. items: description: User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided. type: string type: array uniqueItems: true roleIds: description: Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided. items: description: Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided. format: int64 type: integer type: array uniqueItems: true required: - enabled type: object ProjectIssueTypeMappings: additionalProperties: false description: The project and issue type mappings. properties: mappings: description: The project and issue type mappings. items: $ref: '#/components/schemas/ProjectIssueTypeMapping' type: array writeOnly: true required: - mappings type: object CustomFieldContextDefaultValueDateTime: description: The default value for a date time custom field. properties: contextId: description: The ID of the context. type: string dateTime: description: The default date-time in ISO format. Ignored if `useCurrent` is true. type: string type: type: string useCurrent: default: false description: Whether to use the current date. type: boolean required: - contextId - type type: object CustomFieldContextDefaultValueURL: description: The default value for a URL custom field. properties: contextId: description: The ID of the context. type: string type: type: string url: description: The default URL. type: string required: - contextId - type - url type: object CustomFieldContextDefaultValueForgeUserField: description: Defaults for a Forge user custom field. properties: accountId: description: The ID of the default user. type: string contextId: description: The ID of the context. type: string type: type: string userFilter: $ref: '#/components/schemas/UserFilter' required: - accountId - contextId - type - userFilter type: object IssueTypeDefaultValue: additionalProperties: false description: A default value associated with an issue type within a context. properties: isAnyIssueType: description: True when this default value applies to every issue type covered by the context (no specific issue type). Only present when true; omitted otherwise. type: - boolean - 'null' issueTypeId: description: The ID of the issue type this default value applies to. Null when isAnyIssueType is true. type: - string - 'null' value: $ref: '#/components/schemas/CustomFieldContextDefaultValue' type: object CustomFieldContextDefaultValueSingleOption: description: The default value for a single select custom field. properties: contextId: description: The ID of the context. type: string optionId: description: The ID of the default option. type: string type: type: string required: - contextId - optionId - type type: object CustomFieldContextDefaultValueProject: description: The default value for a project custom field. properties: contextId: description: The ID of the context. type: string projectId: description: The ID of the default project. type: string type: type: string required: - contextId - projectId - type type: object CustomFieldContextDefaultValueForgeMultiUserField: description: Defaults for a Forge collection of users custom field. properties: accountIds: description: The IDs of the default users. items: description: The IDs of the default users. type: string type: array contextId: description: The ID of the context. type: string type: type: string required: - accountIds - contextId - type type: object CustomFieldContextProjectMapping: additionalProperties: false description: Details of a context to project association. properties: contextId: description: The ID of the context. readOnly: true type: string isGlobalContext: description: Whether context is global. readOnly: true type: boolean projectId: description: The ID of the project. readOnly: true type: string required: - contextId type: object CustomFieldContextDefaultValueMultipleVersionPicker: description: The default value for a multiple version picker custom field. properties: contextId: description: The ID of the context. type: string type: type: string versionIds: description: The IDs of the default versions. items: description: The IDs of the default versions. type: string type: array uniqueItems: true versionOrder: description: The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`. type: string required: - contextId - type - versionIds type: object CustomFieldContext: additionalProperties: false description: The details of a custom field context. properties: description: description: The description of the context. type: string id: description: The ID of the context. type: string isAnyIssueType: description: Whether the context apply to all issue types. type: boolean isGlobalContext: description: Whether the context is global. type: boolean name: description: The name of the context. type: string required: - description - id - isAnyIssueType - isGlobalContext - name type: object PageBeanCustomFieldContext: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/CustomFieldContext' readOnly: true type: array type: object CustomFieldContextDefaultValueMultipleOption: description: The default value for a multi-select custom field. properties: contextId: description: The ID of the context. type: string optionIds: description: The list of IDs of the default options. items: description: The list of IDs of the default options. type: string type: array type: type: string required: - contextId - optionIds - type type: object CustomFieldContextDefaultValueFloat: description: Default value for a float (number) custom field. properties: contextId: description: The ID of the context. type: string number: description: The default floating-point number. format: double type: number type: type: string required: - contextId - number - type type: object CustomFieldContextDefaultValueForgeDateTimeField: description: The default value for a Forge date time custom field. properties: contextId: description: The ID of the context. type: string dateTime: description: The default date-time in ISO format. Ignored if `useCurrent` is true. type: string type: type: string useCurrent: default: false description: Whether to use the current date. type: boolean required: - contextId - type type: object CustomFieldContextDefaultValueForgeNumberField: description: Default value for a Forge number custom field. properties: contextId: description: The ID of the context. type: string number: description: The default floating-point number. format: double type: number type: type: string required: - contextId - number - type type: object CustomFieldContextUpdateDetails: additionalProperties: false description: Details of a custom field context. properties: description: description: The description of the custom field context. The maximum length is 255 characters. type: string writeOnly: true name: description: The name of the custom field context. The name must be unique. The maximum length is 255 characters. type: string writeOnly: true type: object CustomFieldContextDefaultValueUpdate: additionalProperties: false description: Default values to update. properties: defaultValues: items: $ref: '#/components/schemas/CustomFieldContextDefaultValue' type: array type: object CustomFieldContextDefaultValueForgeStringField: description: The default text for a Forge string custom field. properties: contextId: description: The ID of the context. type: string text: description: The default text. The maximum length is 254 characters. type: string type: type: string required: - contextId - type type: object CustomFieldContextDefaultValueMultipleGroupPicker: description: The default value for a multiple group picker custom field. properties: contextId: description: The ID of the context. type: string groupIds: description: The IDs of the default groups. items: description: The IDs of the default groups. type: string type: array uniqueItems: true type: type: string required: - contextId - groupIds - type type: object PageBeanContextForProjectAndIssueType: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/ContextForProjectAndIssueType' readOnly: true type: array type: object PageBeanIssueTypeToContextMapping: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/IssueTypeToContextMapping' readOnly: true type: array type: object PageBeanContextDefaultValues: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/ContextDefaultValues' readOnly: true type: array type: object ProjectIds: additionalProperties: false description: A list of project IDs. properties: projectIds: description: The IDs of projects. items: type: string writeOnly: true type: array writeOnly: true required: - projectIds type: object CustomFieldContextDefaultValueCascadingOption: description: The default value for a cascading select custom field. properties: cascadingOptionId: description: The ID of the default cascading option. type: string contextId: description: The ID of the context. type: string optionId: description: The ID of the default option. type: string type: type: string required: - contextId - optionId - type type: object ContextForProjectAndIssueType: additionalProperties: false description: The project and issue type mapping with a matching custom field context. properties: contextId: description: The ID of the custom field context. type: string issueTypeId: description: The ID of the issue type. type: string projectId: description: The ID of the project. type: string required: - contextId - issueTypeId - projectId type: object CustomFieldContextDefaultValueSingleGroupPicker: description: The default value for a group picker custom field. properties: contextId: description: The ID of the context. type: string groupId: description: The ID of the the default group. type: string type: type: string required: - contextId - groupId - type type: object CustomFieldContextDefaultValueForgeObjectField: description: The default value for a Forge object custom field. properties: contextId: description: The ID of the context. type: string object: description: The default JSON object. type: object type: type: string required: - contextId - type type: object CreateCustomFieldContext: additionalProperties: false description: The details of a created custom field context. properties: description: description: The description of the context. type: string id: description: The ID of the context. readOnly: true type: string issueTypeIds: description: The list of issue types IDs for the context. If the list is empty, the context refers to all issue types. items: type: string type: array name: description: The name of the context. type: string projectIds: description: The list of project IDs associated with the context. If the list is empty, the context is global. items: type: string type: array required: - name type: object IssueTypeIds: additionalProperties: false description: The list of issue type IDs. properties: issueTypeIds: description: The list of issue type IDs. items: type: string writeOnly: true type: array writeOnly: true required: - issueTypeIds type: object CustomFieldContextDefaultValueSingleVersionPicker: description: The default value for a version picker custom field. properties: contextId: description: The ID of the context. type: string type: type: string versionId: description: The ID of the default version. type: string versionOrder: description: The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `"releasedFirst"` and `"unreleasedFirst"`. type: string required: - contextId - type - versionId type: object CustomFieldContextDefaultValueTextArea: description: The default text for a text area custom field. properties: contextId: description: The ID of the context. type: string text: description: The default text. The maximum length is 32767 characters. type: string type: type: string required: - contextId - type type: object PageBeanCustomFieldContextDefaultValue: additionalProperties: false description: A page of items. properties: isLast: description: Whether this is the last page. readOnly: true type: boolean maxResults: description: The maximum number of items that could be returned. format: int32 readOnly: true type: integer nextPage: description: If there is another page of results, the URL of the next page. format: uri readOnly: true type: string self: description: The URL of the page. format: uri readOnly: true type: string startAt: description: The index of the first item returned. format: int64 readOnly: true type: integer total: description: The number of items returned. format: int64 readOnly: true type: integer values: description: The list of items. items: $ref: '#/components/schemas/CustomFieldContextDefaultValue' readOnly: true type: array type: object CustomFieldContextSingleUserPickerDefaults: description: Defaults for a User Picker (single) custom field. properties: accountId: description: The ID of the default user. type: string contextId: description: The ID of the context. type: string type: type: string userFilter: $ref: '#/components/schemas/UserFilter' required: - accountId - contextId - type - userFilter type: object CustomFieldContextDefaultValueTextField: description: The default text for a text custom field. properties: contextId: description: The ID of the context. type: string text: description: The default text. The maximum length is 254 characters. type: string type: type: string required: - contextId - type type: object CustomFieldContextDefaultValue: additionalProperties: false discriminator: mapping: datepicker: '#/components/schemas/CustomFieldContextDefaultValueDate' datetimepicker: '#/components/schemas/CustomFieldContextDefaultValueDateTime' float: '#/components/schemas/CustomFieldContextDefaultValueFloat' forge.datetime: '#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField' forge.group: '#/components/schemas/CustomFieldContextDefaultValueForgeGroupField' forge.group.list: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField' forge.number: '#/components/schemas/CustomFieldContextDefaultValueForgeNumberField' forge.object: '#/components/schemas/CustomFieldContextDefaultValueForgeObjectField' forge.string: '#/components/schemas/CustomFieldContextDefaultValueForgeStringField' forge.string.list: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField' forge.user: '#/components/schemas/CustomFieldContextDefaultValueForgeUserField' forge.user.list: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField' grouppicker.multiple: '#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker' grouppicker.single: '#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker' labels: '#/components/schemas/CustomFieldContextDefaultValueLabels' multi.user.select: '#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker' option.cascading: '#/components/schemas/CustomFieldContextDefaultValueCascadingOption' option.multiple: '#/components/schemas/CustomFieldContextDefaultValueMultipleOption' option.single: '#/components/schemas/CustomFieldContextDefaultValueSingleOption' project: '#/components/schemas/CustomFieldContextDefaultValueProject' readonly: '#/components/schemas/CustomFieldContextDefaultValueReadOnly' single.user.select: '#/components/schemas/CustomFieldContextSingleUserPickerDefaults' textarea: '#/components/schemas/CustomFieldContextDefaultValueTextArea' textfield: '#/components/schemas/CustomFieldContextDefaultValueTextField' url: '#/components/schemas/CustomFieldContextDefaultValueURL' version.multiple: '#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker' version.single: '#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker' propertyName: type oneOf: - $ref: '#/components/schemas/CustomFieldContextDefaultValueCascadingOption' - $ref: '#/components/schemas/CustomFieldContextDefaultValueMultipleOption' - $ref: '#/components/schemas/CustomFieldContextDefaultValueSingleOption' - $ref: '#/components/schemas/CustomFieldContextSingleUserPickerDefaults' - $ref: '#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker' - $ref: '#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker' - $ref: '#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker' - $ref: '#/components/schemas/CustomFieldContextDefaultValueDate' - $ref: '#/components/schemas/CustomFieldContextDefaultValueDateTime' - $ref: '#/components/schemas/CustomFieldContextDefaultValueURL' - $ref: '#/components/schemas/CustomFieldContextDefaultValueProject' - $ref: '#/components/schemas/CustomFieldContextDefaultValueFloat' - $ref: '#/components/schemas/CustomFieldContextDefaultValueLabels' - $ref: '#/components/schemas/CustomFieldContextDefaultValueTextField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueTextArea' - $ref: '#/components/schemas/CustomFieldContextDefaultValueReadOnly' - $ref: '#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker' - $ref: '#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeStringField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeObjectField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeGroupField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeNumberField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeUserField' - $ref: '#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField' type: object CustomFieldContextDefaultValueForgeMultiGroupField: description: The default value for a Forge collection of groups custom field. properties: contextId: description: The ID of the context. type: string groupIds: description: The IDs of the default groups. items: description: The IDs of the default groups. type: string type: array uniqueItems: true type: type: string required: - contextId - groupIds - type type: object securitySchemes: OAuth2: description: OAuth2 scopes for Jira flows: authorizationCode: authorizationUrl: https://auth.atlassian.com/authorize scopes: delete:async-task:jira: Delete asynchronous task. delete:attachment:jira: Delete issue attachments. delete:avatar:jira: Delete system and custom avatars. delete:comment.property:jira: Delete issue comment properties. delete:comment:jira: Delete issue comments. delete:dashboard.property:jira: Delete dashboard properties. delete:dashboard:jira: Delete dashboards. delete:field-configuration-scheme:jira: Delete field configuration schemes. delete:field-configuration:jira: Delete field configurations. delete:field.option:jira: Delete field options. delete:field:jira: Delete fields. delete:filter.column:jira: Delete filter columns. delete:filter:jira: Delete filters. delete:group:jira: Delete user groups. delete:issue-link-type:jira: Delete issue link types. delete:issue-link:jira: Delete issue links. delete:issue-type-scheme:jira: Delete issue type schemes. delete:issue-type-screen-scheme:jira: Delete issue type screen schemes. delete:issue-type.property:jira: Delete issue type properties. delete:issue-type:jira: Delete issue types. delete:issue-worklog.property:jira: Delete issue worklog properties. delete:issue-worklog:jira: Delete issue worklogs. delete:issue.property:jira: Delete issue properties. delete:issue.remote-link:jira: Delete issue remote links. delete:issue:jira: Delete issues. delete:permission-scheme:jira: Delete permission schemes. delete:permission:jira: Delete permissions. delete:project-category:jira: Delete project categories. delete:project-role:jira: Delete project roles. delete:project-version:jira: Delete project versions. delete:project.avatar:jira: Delete project avatars. delete:project.component:jira: Delete project components. delete:project.property:jira: Delete project properties. delete:project:jira: Delete projects and their details, such as issue types, project lead, and avatars. delete:screen-scheme:jira: Delete screen schemes. delete:screen-tab:jira: Delete screen tabs. delete:screen:jira: Delete screens. delete:screenable-field:jira: Delete screenable fields. delete:user-configuration:jira: Delete user configurations. delete:user.property:jira: Delete user properties. delete:webhook:jira: Delete webhooks. delete:workflow-scheme:jira: Delete workflow schemes. delete:workflow.property:jira: Delete workflow properties. delete:workflow:jira: Delete workflows. manage:jira-configuration: Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types. manage:jira-project: Create and edit project settings and create new project-level objects, for example, versions, components. manage:jira-webhook: Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks. read:app-data:jira: Read app data. read:application-role:jira: View application roles. read:attachment:jira: View issue attachments. read:audit-log:jira: View audit logs. read:avatar:jira: View system and custom avatars. read:comment.property:jira: View issue comment properties. read:comment:jira: View issue comments. read:custom-field-contextual-configuration:jira: Read custom field contextual configurations. read:dashboard.property:jira: View dashboard properties. read:dashboard:jira: View dashboards. read:email-address:jira: View email addresses of all users regardless of the user's profile visibility settings. read:field-configuration-scheme:jira: View field configuration schemes. read:field-configuration:jira: Read field configurations. read:field.default-value:jira: View field default values. read:field.option:jira: View field options. read:field.options:jira: Read field options. read:field:jira: View fields. read:filter.column:jira: View filter columns. read:filter.default-share-scope:jira: View filter default share scopes. read:filter:jira: View filters. read:group:jira: View user groups. read:instance-configuration:jira: View instance configurations. read:issue-details:jira: View issue details. read:issue-event:jira: Read issue events. read:issue-field-values:jira: View issue field valueses. read:issue-link-type:jira: View issue link types. read:issue-link:jira: View issue links. read:issue-meta:jira: View issue meta. read:issue-security-level:jira: View issue security levels. read:issue-security-scheme:jira: View issue security schemes. read:issue-status:jira: View issue statuses. read:issue-type-hierarchy:jira: Read issue type hierarchies. read:issue-type-scheme:jira: View issue type schemes. read:issue-type-screen-scheme:jira: View issue type screen schemes. read:issue-type.property:jira: View issue type properties. read:issue-type:jira: View issue types. read:issue-worklog.property:jira: View issue worklog properties. read:issue-worklog:jira: View issue worklogs. read:issue.changelog:jira: View issue changelogs. read:issue.property:jira: View issue properties. read:issue.remote-link:jira: View issue remote links. read:issue.time-tracking:jira: View issue time trackings. read:issue.transition:jira: View issue transitions. read:issue.vote:jira: View issue votes. read:issue.votes:jira: View issue voteses. read:issue.watcher:jira: View issue watchers. read:issue:jira: View issues. read:jira-expressions:jira: View jira expressions. read:jira-user: View user information in Jira that you have access to, including usernames, email addresses, and avatars. read:jira-work: Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs). read:jql:jira: View JQL. read:label:jira: View labels. read:license:jira: View licenses. read:notification-scheme:jira: View notification schemes. read:permission-scheme:jira: View permission schemes. read:permission:jira: View permissions. read:priority:jira: View priorities. read:project-category:jira: View project categories. read:project-role:jira: View project roles. read:project-type:jira: View project types. read:project-version:jira: View project versions. read:project.avatar:jira: Read project avatars. read:project.component:jira: View project components. read:project.email:jira: View project emails. read:project.feature:jira: Read project features. read:project.property:jira: View project properties. read:project:jira: View projects. read:resolution:jira: View resolutions. read:role:jira: View roles. read:screen-field:jira: View screen fields. read:screen-scheme:jira: View screen schemes. read:screen-tab:jira: View screen tabs. read:screen:jira: View screens. read:screenable-field:jira: View screenable fields. read:status:jira: View statuses. read:user-configuration:jira: View user configurations. read:user.columns:jira: View user columnses. read:user.property:jira: View user properties. read:user:jira: View users. read:webhook:jira: View webhooks. read:workflow-scheme:jira: View workflow schemes. read:workflow.property:jira: View workflow properties. read:workflow:jira: View workflows. send:notification:jira: Send notifications. validate:jql:jira: Validate JQL. write:app-data:jira: Write app data. write:attachment:jira: Create and update issue attachments. write:avatar:jira: Create and update system and custom avatars. write:comment.property:jira: Create and update issue comment properties. write:comment:jira: Create and update issue comments. write:custom-field-contextual-configuration:jira: Save custom field contextual configurations. write:dashboard.property:jira: Create and update dashboard properties. write:dashboard:jira: Create and update dashboards. write:field-configuration-scheme:jira: Create and update field configuration schemes. write:field-configuration:jira: Save field configurations. write:field.default-value:jira: Create and update field default values. write:field.option:jira: Create and update field options. write:field:jira: Create and update fields. write:filter.column:jira: Create and update filter columns. write:filter.default-share-scope:jira: Create and update filter default share scopes. write:filter:jira: Create and update filters. write:group:jira: Create and update user groups. write:instance-configuration:jira: Create and update instance configurations. write:issue-link-type:jira: Create and update issue link types. write:issue-link:jira: Create and update issue links. write:issue-type-scheme:jira: Create and update issue type schemes. write:issue-type-screen-scheme:jira: Create and update issue type screen schemes. write:issue-type.property:jira: Create and update issue type properties. write:issue-type:jira: Create and update issue types. write:issue-worklog.property:jira: Create and update issue worklog properties. write:issue-worklog:jira: Create and update issue worklogs. write:issue.property:jira: Create and update issue properties. write:issue.remote-link:jira: Create and update issue remote links. write:issue.time-tracking:jira: Create and update issue time trackings. write:issue.vote:jira: Create and update issue votes. write:issue.watcher:jira: Create and update issue watchers. write:issue:jira: Create and update issues. write:jira-work: Create and edit issues in Jira, post comments, create worklogs, and delete issues. write:permission-scheme:jira: Create and update permission schemes. write:permission:jira: Create and update permissions. write:project-category:jira: Create and update project categories. write:project-role:jira: Create and update project roles. write:project-version:jira: Create and update project versions. write:project.avatar:jira: Create and update project avatars. write:project.component:jira: Create and update project components. write:project.email:jira: Create and update project emails. write:project.feature:jira: Save project features. write:project.property:jira: Create and update project properties. write:project:jira: Create and update projects. write:screen-scheme:jira: Create and update screen schemes. write:screen-tab:jira: Create and update screen tabs. write:screen:jira: Create and update screens. write:screenable-field:jira: Create and update screenable fields. write:user-configuration:jira: Create and update user configurations. write:user.property:jira: Create and update user properties. write:webhook:jira: Create and update webhooks. write:workflow-scheme:jira: Create and update workflow schemes. write:workflow.property:jira: Create and update workflow properties. write:workflow:jira: Create and update workflows. tokenUrl: https://auth.atlassian.com/oauth/token type: oauth2 basicAuth: description: You can access this resource via basic auth. scheme: basic type: http externalDocs: description: Find out more about Atlassian products and services. url: http://www.atlassian.com x-atlassian-narrative: documents: - anchor: about body: "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses." title: About - anchor: version body: "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest\nversion. [Version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) and\nversion 3 of the API offer the same collection of operations. However, version 3 provides support for\nthe [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)\n(ADF) in:\n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields\n (`textfield`) accept a string and don't handle Atlassian Document Format content.\n" title: Version - anchor: authentication body: "### Forge apps\n\nFor Forge apps, [REST API scopes](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) \nare used when authenticating with Jira Cloud platform. See [Add scopes to call an Atlassian REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/rest/api/3/`\n\nFor example, `/rest/api/3/issue/DEMO-1`\n\n### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\nThe URIs for Connect app REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n### Other integrations\n\nFor integrations that are not Forge or Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as for operations _OAuth scopes required_). See \n[OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) \nfor details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira//rest/api/3/`\n\nFor example, `https://api.atlassian.com/ex/jira/35273b54-3f06-40d2-880f-dd28cf8daafa/rest/api/3/issue/DEMO-1`\n\n### Ad-hoc API calls\n\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details. \n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https:///rest/api/3/`\n\nFor example, `https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n" title: Authentication and authorization - anchor: permissions body: "### Operation permissions\n\nMost operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. There is a default group for this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and [Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the default product access group (for example, \n_jira-software-users-acmesite_) have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n\n### Anonymous access\n\nSome operations provide support for anonymous access. However, anonymous access is only available if \nthe Jira permission needed to access the object or records returned by the operation is granted to \nthe _Public_ group. See [Allowing anonymous access to your project](https://confluence.atlassian.com/x/GDxxLg) \nfor details.\n\nIf an operation is called anonymously and anonymous access is not available, the operation will return \nan error. Note that not all operations that correspond to objects that can be given public access \nprovide for anonymous access.\n" title: Permissions - anchor: expansion body: "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that a page can return. Each operation can have a different limit for\n the number of items returned, and these limits may change without notice. To find the maximum number of items \n that an operation could return, set `maxResults` to a large number—for example, over 1000—and if the returned value of `maxResults` is less than the requested value, the returned value is the maximum.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n" title: Expansion, pagination, and ordering - anchor: timestamps body: 'By default, top-level timestamps (e.g. updated and created) are returned in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format, in the system default user time zone. To return date time data in the logged in user''s timezone, please refer to `renderedFields` property under the `expand` query parameter in relevant APIs. ' title: Timestamps - anchor: special-request-headers body: 'The following request and response headers define important metadata for the Jira Cloud REST API resources. - `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests. Otherwise the request is blocked by cross-site request forgery (CSRF/XSRF) protection. - `X-Force-Accept-Language` (request): controls how the standard HTTP `Accept-Language` header is processed. By default `Accept-Language` is ignored and the response is in the language configured in the user''s profile or, when no language is configured for the user, the default Jira instance language. For the response to recognize `Accept-Language` send `X-Force-Accept-Language = true` as well. If `Accept-Language` requests a language that Jira can return the response is in that language, otherwise Jira returns the response in the default language. If `Accept-Language` is not specified the response is in the default language. - `X-AAccountId` (response): This response header contains the Atlassian account ID of the authenticated user.' title: Special headers - anchor: anonymous-operations body: " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"" title: Anonymous operations - anchor: async-operations body: "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished." title: Asynchronous operations - anchor: experimental body: "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport issues to [Developer and Marketplace support](https://developer.atlassian.com/support) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" title: Experimental features - anchor: status-codes body: "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```" title: Status codes