This resource represents the values of custom fields added by Forge apps. Use it to update the value of a custom field on issues.
Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request.
Apps can only perform this operation on custom fields and custom field types declared in their own manifests.
Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
write:app-data:jiraConnect apps cannot access this REST resource.
boolean
array<MultipleCustomFieldValuesUpdate>
Returned if the request 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 = `{
"updates": [
{
"customField": "customfield_10010",
"issueIds": [
10010,
10011
],
"value": "new value"
},
{
"customField": "customfield_10011",
"issueIds": [
10010
],
"value": 1000
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/app/field/value`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Updates the value of a custom field on one or more issues.
Apps can only perform this operation on custom fields and custom field types declared in their own manifests.
Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
write:app-data:jiraConnect apps cannot access this REST resource.
string
Requiredboolean
array<CustomFieldValueUpdate>
Returned if the request 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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"updates": [
{
"issueIds": [
10010
],
"value": "new value"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/app/field/{fieldIdOrKey}/value`, {
method: 'PUT',
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: