Identify Form ID for Issue-Related Actions in Jira Cloud
Platform Notice: Cloud Only - This article only applies to Atlassian apps on the cloud platform.
Summary
You would like to use Forms API to get/submit/reopen/delete a form attached on a work item for Jira Automation, a third-party app, or any integration. This article will present the difference between the Template and Association IDs related to a JSM Form.
Diagnosis
When a new form is created in JSM via Space Settings → Forms, a Template ID is generated.
When you attach this form on a work item, a new Association ID will be created for this.
A common error is to use the Template ID from the Forms tab to get a form attached to a work item using the GET form REST API endpoint, instead of the Association ID which will result on the the response is 404 FORM_NOT_FOUND with the detail The provided form ID was not found.
Solution
You need to get the correct form Association ID, which is created when you attach the form to the work item. First you need to get the work item forms index using the GET form Index REST API endpoint. This will return the following response:
Response
[
{
"id": "g4c5211b-0230-4d3e-aqw3-e29764377452",
"formTemplate": {
"id": "03h37dd0-r4a6-u798-hg41-3kid637fed40"
},
"internal": false,
"submitted": true,
"lock": false,
"name": "<FormName>",
"updated": "2023-06-20T18:53:48.348Z"
}
]This will return all forms attached to the work item. The top-level id value from the response is the Association ID (g4c5211b-0230-4d3e-aqw3-e29764377452) to be used for actions on the form attached with the work item.
The value in formTemplate.id is the global form Template ID, which can be used to confirm we have the correct Form template selected on Space Settings → Forms (if there are multiples).
Following this example, for GET form REST API endpoint this would be the request:
Request
https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/g4c5211b-0230-4d3e-aqw3-e29764377452Was this helpful?