How can I get the form ID to use it with Proforma API
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. 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
Scenario
The purpose of this KB article is to show how to get the Form ID, which is required to use the Proforma API.
Environment
Jira Data Center with the Proforma app installed on top.
Resolution
The form ID can be retrieve by using the URL, after replacing:
<JIRA_BASE_URL> with Jira Base URL
<issueId_or_IssueKey> with the Jira Issue ID or Key
1
<JIRA_BASE_URL>/rest/api/2/issue/<issueId_or_issueKey>/properties/proforma.formsThe result looks like this:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"key": "proforma.forms",
"value": {
"schemaVersion": 4,
"forms": [
{
"id": 1,
"projectFormId": 1,
"internal": true,
"submitted": true,
"name": "3/13/2024 New Form",
"updated": "2024-03-13T19:52:23.822793Z"
}
]
}
}Where the form ID = 1.
With that you can use Proforma APIs, for example:
1
/rest/proforma/1/issue/{issueKey}/form/{formId}/answers Was this helpful?