How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Issue custom field contexts API

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.

Jira Issue custom field contexts API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Issue Custom Field Contexts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 14 operations across 11 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

14 operations 11 paths 48 schemas 1 DELETE5 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Issue custom field contexts API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 5 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Issue Custom Field Contexts 14

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 custo…

GET
/rest/api/3/field/{fieldId}/context
Get custom field contexts
getContextsForField 6 params → 200401403404
POST
/rest/api/3/field/{fieldId}/context
Create custom field context
createCustomFieldContext 1 param body → 201400401404409
GET
/rest/api/3/field/{fieldId}/context/defaultValuedeprecated
Get custom field contexts default values
getDefaultValues 4 params → 200400401403404
PUT
/rest/api/3/field/{fieldId}/context/defaultValuedeprecated
Set custom field contexts default values
setDefaultValues 1 param body → 204400401403404
GET
/rest/api/3/field/{fieldId}/context/defaultValues
Get default values for a custom field grouped by context and issue type
getContextDefaultValues 5 params → 200401403404
GET
/rest/api/3/field/{fieldId}/context/issuetypemapping
Get issue types for custom field context
getIssueTypeMappingsForContexts 4 params → 200401403
POST
/rest/api/3/field/{fieldId}/context/mapping
Get custom field contexts for projects and issue types
getCustomFieldContextsForProjectsAndIssueTypes 3 params body → 200400401403404
GET
/rest/api/3/field/{fieldId}/context/projectmapping
Get project mappings for custom field context
getProjectContextMapping 4 params → 200401403404
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}
Delete custom field context
deleteCustomFieldContext 2 params → 204400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}
Update custom field context
updateCustomFieldContext 2 params body → 204400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/issuetype
Add issue types to context
addIssueTypesToContext 2 params body → 204400401403404409
POST
/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove
Remove issue types from context
removeIssueTypesFromContext 2 params body → 204400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/project
Assign custom field context to projects
assignProjectsToCustomFieldContext 2 params body → 204400401403404
POST
/rest/api/3/field/{fieldId}/context/{contextId}/project/remove
Remove custom field context from projects
removeCustomFieldContextFromProjects 2 params body → 204400401403404

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are PageBeanContextDefaultValues (7 properties), PageBeanIssueTypeToContextMapping (7 properties), PageBeanCustomFieldContextProjectMapping (7 properties), PageBeanCustomFieldContext (7 properties). Each schema is shown below with its type and property counts.

CustomFieldContextDefaultValueSingleVersionPicker
object
The default value for a version picker custom field.
4 properties 3 required
CustomFieldContextDefaultValueFloat
object
Default value for a float (number) custom field.
3 properties 3 required
CustomFieldContextDefaultValueDate
object
The default value for a Date custom field.
4 properties 2 required
CustomFieldContextDefaultValueMultipleVersionPicker
object
The default value for a multiple version picker custom field.
4 properties 3 required
ProjectIds
object
A list of project IDs.
1 property 1 required
ContextForProjectAndIssueType
object
The project and issue type mapping with a matching custom field context.
3 properties 3 required
CustomFieldContextDefaultValueForgeMultiStringField
object
The default text for a Forge collection of strings custom field.
3 properties 2 required
CustomFieldContextUpdateDetails
object
Details of a custom field context.
2 properties
CustomFieldContextDefaultValueTextField
object
The default text for a text custom field.
3 properties 2 required
PageBeanCustomFieldContextProjectMapping
object
A page of items.
7 properties
PageBeanCustomFieldContext
object
A page of items.
7 properties
PageBeanCustomFieldContextDefaultValue
object
A page of items.
7 properties
CustomFieldContextProjectMapping
object
Details of a context to project association.
3 properties 1 required
CustomFieldContextDefaultValueCascadingOption
object
The default value for a cascading select custom field.
4 properties 3 required
ProjectIssueTypeMappings
object
The project and issue type mappings.
1 property 1 required
CustomFieldContextDefaultValueForgeMultiUserField
object
Defaults for a Forge collection of users custom field.
3 properties 3 required
UserFilter
object
Filter for a User Picker (single) custom field.
3 properties 1 required
CustomFieldContextDefaultValueForgeMultiGroupField
object
The default value for a Forge collection of groups custom field.
3 properties 3 required
CustomFieldContext
object
The details of a custom field context.
5 properties 5 required
CustomFieldContextDefaultValueUpdate
object
Default values to update.
1 property
CustomFieldContextDefaultValueSingleGroupPicker
object
The default value for a group picker custom field.
3 properties 3 required
CustomFieldContextDefaultValueForgeStringField
object
The default text for a Forge string custom field.
3 properties 2 required
IssueTypeDefaultValue
object
A default value associated with an issue type within a context.
3 properties
CustomFieldContextDefaultValueURL
object
The default value for a URL custom field.
3 properties 3 required
IssueTypeIds
object
The list of issue type IDs.
1 property 1 required
CustomFieldContextDefaultValueSingleOption
object
The default value for a single select custom field.
3 properties 3 required
CustomFieldContextDefaultValueMultipleGroupPicker
object
The default value for a multiple group picker custom field.
3 properties 3 required
CustomFieldContextDefaultValueLabels
object
Default value for a labels custom field.
3 properties 3 required
CustomFieldContextDefaultValueMultiUserPicker
object
The default value for a User Picker (multiple) custom field.
3 properties 3 required
CustomFieldContextDefaultValue
object
CustomFieldContextDefaultValueForgeUserField
object
Defaults for a Forge user custom field.
4 properties 4 required
CustomFieldContextDefaultValueProject
object
The default value for a project custom field.
3 properties 3 required
CustomFieldContextDefaultValueMultipleOption
object
The default value for a multi-select custom field.
3 properties 3 required
CustomFieldContextDefaultValueForgeDateTimeField
object
The default value for a Forge date time custom field.
4 properties 2 required
PageBeanContextDefaultValues
object
A page of items.
7 properties
CustomFieldContextDefaultValueDateTime
object
The default value for a date time custom field.
4 properties 2 required
CustomFieldContextDefaultValueForgeObjectField
object
The default value for a Forge object custom field.
3 properties 2 required
CustomFieldContextSingleUserPickerDefaults
object
Defaults for a User Picker (single) custom field.
4 properties 4 required
CreateCustomFieldContext
object
The details of a created custom field context.
5 properties 1 required
CustomFieldContextDefaultValueReadOnly
object
The default text for a read only custom field.
3 properties 2 required
CustomFieldContextDefaultValueTextArea
object
The default text for a text area custom field.
3 properties 2 required
CustomFieldContextDefaultValueForgeNumberField
object
Default value for a Forge number custom field.
3 properties 3 required
IssueTypeToContextMapping
object
Mapping of an issue type to a context.
3 properties 1 required
PageBeanContextForProjectAndIssueType
object
A page of items.
7 properties
CustomFieldContextDefaultValueForgeGroupField
object
The default value for a Forge group custom field.
3 properties 3 required
ContextDefaultValues
object
Default values grouped by custom field context.
2 properties 1 required
ProjectIssueTypeMapping
object
The project and issue type mapping.
2 properties 2 required
PageBeanIssueTypeToContextMapping
object
A page of items.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-custom-field-contexts-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Issue custom field contexts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.