How to update Epic Intake form data in Jira Align using API
Platform Notice: Cloud and Data Center - This article applies equally to both cloud and data center platforms.
Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
This article shows how to update Epic Intake form data in Jira Align using API.
Environment
Jira Align
Solution
We can use the below query to identify the custom field details for the Intake form data used in the Epics:
https://<ja_instance>/rest/align/api/2/Epics/<epic_id>/editmeta
Once we have the custom field IDs, we can update the values for the specific Intake form entries via a Patch request:
https://<ja-instance>/rest/align/api/2/Epics/<epic_id>/
Body should contain the data to be replaced.
Example Epic Intake form for Epic ID 8158 in Jira Align:
Using GET API request for fetching Custom field details:
https://<ja-domain>.jiraalign.com/rest/align/api/2/Epics/8207/editmeta
API Results:
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
"customFields": [
{
"customfield_70001": {
"type": 1,
"required": false,
"active": false,
"name": "Justification",
"schema": {
"type": "string",
"customId": 70001
},
"key": "customfield_70001"
}
},
{
"customfield_70002": {
"type": 1,
"required": false,
"active": false,
"name": "Department",
"schema": {
"type": "string",
"customId": 70002
},
"key": "customfield_70002"
}
},
{
"customfield_70003": {
"type": 1,
"required": false,
"active": false,
"name": "Requestor",
"schema": {
"type": "string",
"customId": 70003
},
"key": "customfield_70003"
}
},
{
"customfield_70004": {
"type": 1,
"required": false,
"active": false,
"name": "Reviewer",
"schema": {
"type": "string",
"customId": 70004
},
"key": "customfield_70004"
}
},
{
"customfield_70005": {
"type": 1,
"required": false,
"active": false,
"name": "Approver",
"schema": {
"type": "string",
"customId": 70005
},
"key": "customfield_70005"
}
}PATCH request to modify the string "Department" whose ID is 'customfield_70002':
https://<ja-domain>.jiraalign.com/rest/align/api/2/Epics/8207/
Path should indicate the position of the custom field (in our case, the array location is 1 as per the above GET request)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[
{
"op":"replace",
"path":"customFields/1",
"value":
{
"customfield_70002":
[
{
"value": "test Siva"
}
]
}
}
]Reference Articles:
Was this helpful?