How to get Forms Data VIA RestAPI in Cloud

[Aditya Samala]

I am trying to pull form data via RestAPI to export into external software and revert back updated data into Jira.

I have used https://testabc.atlassian.net/rest/api/3/issue/test-123

I got Json response but the defined form description field and to other custom fields doesn't have data it showing as Null.

Could you please help with Correct API

I got some community links which are In cloud RestAPI doesn't work. To pull the form data but which are old posts.

https://community.atlassian.com/t5/Jira-Service-Management/Pulling-Data-from-Forms/qaq-p/2044455

[Roman Pankovski]

Hi there!

I've got the same problem with Jira Cloud: 

Using url:

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

Response:

{
"timestamp": "2024-07-24T08:27:31.314094535Z",
"status": 404,
"error": "Not Found",
"message": "No message available",
"path": "/jira/forms/cloud/{correct cloud id}/issue/{accessible issue key or id}/form"
}

Issue data is fully accessible and Form data available by url:
https://{name}.atlassian.net/rest/api/3/issue/{issue .key}/properties/proforma.forms.i1 

Any advices?

[Aditya Samala]

.

[Joseph Chung Yin]

@Aditya Samala 

Welcome to the community.  Here is the REST APIs for FORMS against the CLOUD env - https://developer.atlassian.com/cloud/forms/rest/api-group-forms-on-issue/#api-group-forms-on-issue

This set (FORMS REST APIs for the CLOUD env) was released back in Q2 2023 + enhancements of it back in Q1 2024

Hope this helps.

Best, Joseph Chung Yin

Jira/JSM Functional Lead, Global Technology Applications Team

Viasat Inc.

[Aditya Samala]

Thanks for your quick response, Could you please help me how to get cloud id and form id to update API.

[Joseph Chung Yin]

It is documented in the REST APIs page that I sent ...

Here is the link I believe to retrieve form  under the "Forms on Portal" section.

ttps://developer.atlassian.com/cloud/forms/rest/api-group-forms-on-portal/#api-group-forms-on-portal

Here is the link on the FORMS REST APIs - https://developer.atlassian.com/cloud/forms/rest/intro/#about

If my suggestion helped you, please click on "Accept answer" when you have a chance, so others with the similar asks will see the posting as an answered one.

Best Joseph

[Aditya Samala]

https://test atlassian.net/jira/forms/cloud/9bbafc70-1534-44/issue/Test-123/form/ba2763f159f0a8ec8

trying to use this API but getting bad request response

[Joseph Chung Yin]

Check your REST APIs call -

From the documentation -

They syntax is /servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form

I believe your call syntax is incorrect.

Best, Joseph

[Aditya Samala]

I am using cloud ;

https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}'

[Joseph Chung Yin]

Look at the syntax of your call.  It needs to follow what the documentation stated...

/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form

Are you using JSM or Jira for the Cloud env?

Best, Joseph

[Aditya Samala]

I am Using JSM, I have followed the document which you have shared 

[Joseph Chung Yin]

Ok.. 

What is the actual REST Api that you are getting the error?  Please provide 

You posted previously as 

https://test atlassian.net/jira/forms/cloud/9bbafc70-1534-44/issue/Test-123/form/ba2763f159f0a8ec8

Which didn't follow the syntax as documented.

Lastly, what is the bad response error code?

Best, Joseph

[Aditya Samala]

This is my API which i have followed same like your shared doc, please let me know where i am missing.

https://ABC-test-333.atlassian.net/jira/forms/cloud/9bbafc70-1534-445d-a74f-/issue/TestPIN-637/form/a45dba2763f289b43c91 \

https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}'

[Joseph Chung Yin]

Typical 404 error is because "The requested issue or form was not found or the user does not have permission to view it."

Can you make sure that your issue and your permission that you used to authenticate the connection is setup properly?

Best, Joseph

[Aditya Samala]

I am using Basic Auth, able run other API's with the same Authentication.

I got form id by using below path  Project Settings → Forms. right click > Inspects > Elements

[Aditya Samala]

I received request ids after updating my API, and now i want to know how to obtain the form's data.

https://test-sand-334.atlassian.net/rest/servicedeskapi/servicedesk/1156/requesttype/2482/form