Servicedesk api how to post and get forms

Question

Hello,

My team and I operate a JIRA Service Desk page where our customers can complete forms to create support tickets.

Presently, I am seeking a method to populate a form via the JIRA Service Desk API. However, thus far, I have been unable to find an endpoint that adequately addresses this requirement.

Firstly, I m trying to find a GET endpoint to retrieve all the form fields that require completion.

Additionally, I need to find POST endpoint to submit a JSON containing the responses, which would then automatically generate the form.

Can anyone assist me with this matter?

Example url of our form and example of one of our forms:
https://company_servicedesk/plugins/servlet/desk/portal/80/create/2803

Thank you in advance,

Tiago Costa

walcantara · Answer

Good afternoon, I managed to get the forms ID, but I am not having success in the post, even passing the forms ID it returns 404, what would be the correct endpoint for the call?

Fernando Eugênio da Silva · Answer

@Tiago Costa , Welcome to the Atlassian Community!

First of all, this is the documentation about REST API and Forms in Jira Cloud: The Forms REST API (atlassian.com)

Second, to get all fields filled by forms in your Jira you'll need to give a GET using this informations:

Endpoint: https://api.atlassian.com/jira/forms/cloud/{org-id}/issue/{issue-key}/form

org-id: is the id when you access 'user management' tab. The org-id is the id presented in your URL browser.

https://admin.atlassian.com/s/{org-id}/users?referrerName=JIRA

As this is an experimental API, every time you're using forms API it's required to use the header: X-ExperimentalApi:opt-in

When you did this first GET, Jira will return to you the real form ID. You'will need to use this form ID in the next step to get your forms response.

---

Forms Response:

Endpoint: https://api.atlassian.com/jira/forms/cloud/{org-id}/request/{issue-key}/form/{form-id}

In this get you'll see all details of the fields in forms and options. The answer you'll see in the final inside state {answers}.

Is a different structure than Jira, so take some time to read and understand the documentation to GET and to POST values.

Hope these informations helps you anyway,

Let us know in case you have doubts.

Regards,

Fernando