This resource represents issue custom field contexts. Use it to:
Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:
id only, all contexts from the list of IDs.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)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.
manage:jira-configurationread:field:jira, read:custom-field-contextual-configuration:jiraConnect app scope required: READ
string
Requiredboolean
boolean
array<integer>
integer
integer
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"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
}
]
}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.
manage:jira-configurationread:field:jira, write:field:jira, read:custom-field-contextual-configuration:jiraConnect app scope required: ADMIN
string
Requiredstring
array<string>
string
Requiredarray<string>
Returned if the custom field context is created.
The details of a created custom field context.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "A context used to define the custom field options for bugs.",
"issueTypeIds": [
"10010"
],
"name": "Bug fields context",
"projectIds": []
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
{
"id": "10025",
"name": "Bug fields context",
"description": "A context used to define the custom field options for bugs.",
"projectIds": [],
"issueTypeIds": [
"10010"
]
}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.Permissions required: Administer Jira global permission.
manage:jira-configurationread:field.default-value:jiraConnect app scope required: READ
string
Requiredarray<integer>
integer
integer
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/defaultValue`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"isLast": true,
"maxResults": 50,
"startAt": 0,
"total": 3,
"values": [
{
"contextId": "10100",
"optionId": "10001"
},
{
"contextId": "10101",
"optionId": "10003"
},
{
"contextId": "10103"
}
]
}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.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:field.default-value:jiraConnect app scope required: ADMIN
string
Requiredarray<oneOf [CustomFieldContextDefaultValueCascadingOption, CustomFieldContextDefaultValueMultipleOption, CustomFieldContextDefaultValueSingleOption, CustomFieldContextSingleUserPickerDefaults, CustomFieldContextDefaultValueMultiUserPicker, CustomFieldContextDefaultValueSingleGroupPicker, CustomFieldContextDefaultValueMultipleGroupPicker, CustomFieldContextDefaultValueDate, CustomFieldContextDefaultValueDateTime, CustomFieldContextDefaultValueURL, CustomFieldContextDefaultValueProject, CustomFieldContextDefaultValueFloat, CustomFieldContextDefaultValueLabels, CustomFieldContextDefaultValueTextField, CustomFieldContextDefaultValueTextArea, CustomFieldContextDefaultValueReadOnly, CustomFieldContextDefaultValueSingleVersionPicker, CustomFieldContextDefaultValueMultipleVersionPicker, CustomFieldContextDefaultValueForgeStringField, CustomFieldContextDefaultValueForgeMultiStringField, CustomFieldContextDefaultValueForgeObjectField, CustomFieldContextDefaultValueForgeDateTimeField, CustomFieldContextDefaultValueForgeGroupField, CustomFieldContextDefaultValueForgeMultiGroupField, CustomFieldContextDefaultValueForgeNumberField, CustomFieldContextDefaultValueForgeUserField, CustomFieldContextDefaultValueForgeMultiUserField]>
Returned if operation is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"defaultValues": [
{
"contextId": "10100",
"optionId": "10001",
"type": "option.single"
},
{
"contextId": "10101",
"optionId": "10003",
"type": "option.single"
},
{
"contextId": "10103",
"optionId": "10005",
"type": "option.single"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/defaultValue`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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.
manage:jira-configurationread:field:jiraConnect app scope required: READ
string
Requiredarray<integer>
integer
integer
Returned if operation is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/issuetypemapping`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 3,
"values": [
{
"contextId": "10001",
"issueTypeId": "10010"
},
{
"contextId": "10001",
"issueTypeId": "10011"
},
{
"contextId": "10002",
"isAnyIssueType": true
}
]
}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.
manage:jira-configurationread:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
integer
The list of project and issue type mappings.
array<ProjectIssueTypeMapping>
RequiredReturned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"mappings": [
{
"issueTypeId": "10000",
"projectId": "10000"
},
{
"issueTypeId": "10001",
"projectId": "10000"
},
{
"issueTypeId": "10002",
"projectId": "10001"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/mapping`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"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"
}
]
}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.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:field:jiraConnect app scope required: READ
string
Requiredarray<integer>
integer
integer
Returned if the request is successful.
A page of items.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/projectmapping`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"isLast": true,
"maxResults": 100,
"startAt": 0,
"total": 2,
"values": [
{
"contextId": "10025",
"projectId": "10001"
},
{
"contextId": "10026",
"isGlobalContext": true
}
]
}Updates a custom field context.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
Requiredstring
string
Returned if the context is updated.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"description": "A context used to define the custom field options for bugs.",
"name": "Bug fields context"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a custom field context.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
RequiredReturned if the context is deleted.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Adds issue types to a custom field context, appending the issue types to the issue types list.
A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types.
If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
Requiredarray<string>
RequiredReturned if operation is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeIds": [
"10001",
"10005",
"10006"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}/issuetype`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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.
manage:jira-configurationwrite:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
Requiredarray<string>
RequiredReturned if operation is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"issueTypeIds": [
"10001",
"10005",
"10006"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Assigns a custom field context to projects.
If any project in the request is assigned to any context of the custom field, the operation fails.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
Requiredarray<string>
RequiredReturned if operation is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"projectIds": [
"10001",
"10005",
"10006"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}/project`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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.
manage:jira-configurationwrite:field:jiraConnect app scope required: ADMIN
string
Requiredinteger
Requiredarray<string>
RequiredReturned if the custom field context is removed from the projects.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"projectIds": [
"10001",
"10005",
"10006"
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/field/{fieldId}/context/{contextId}/project/remove`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: