nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Updating custom form values in JSM via REST

Iain McCarthy

Hi all. I am looking for some working examples of custom form field updates via REST.

I can't use custom Jira fields to map, as my forms use data connections, so must go direct through the forms API.

The Atlassian Doc falls JUST short of being useful, here:

https://developer.atlassian.com/cloud/forms/rest/api-group-forms-on-issue/\#api-issue-issueidorkey-form-formid-put

This provides the endpoint and request structure but no examples of the field data itself, which is the operative bit.

--data '{
"answers": {}
}'

This document appears to show the valid structure, but I can't get it to work. If I send this as a payload (the long string is the field's dcId, I've also tried the numeric field number),

{
"answers": {
"68f27692-5a3c-4943-b7d4-b11d80e3f44b": { "choices": ["3441468"] }
}
}

I get the following response:

"errors":[{"status":400,"code":"BAD_REQUEST","title":"There was an issue with your request","detail":"1 error found in JSON: (1) should be a JSON object"}]}

Any example of drop-down, text and numeric field updates that you have working on your instances would be super helpful, thank you!

Accepted answers

John Funk

Hi Iain - have you also posted this over in the Developers Community?

https://community.developer.atlassian.com/

Darryl Lee

Hi @Iain McCarthy - the page you shared (Integrating Custom Form Fields into Jira Ticket Creation API) says:

(Experimental) Provides answers to the form associated with a request type that is attached to the request on creation.

(Emphasis mine.)

So I believe that this is only for populating a form when you are creating a NEW issue.

You said you're looking to update fields on a form. I take that to mean you're wanting to change values on forms that have already been submitted.

My reading of Forms API is that to update an existing form you would need to:

Get the IDs of all forms attached to an ticket: Get form index
Get existing answers for your form (assuming it's just one), using the formId from the step above. I think when you save answers you have to save all of them. So you'll want to get all the values that you'll need to retain or update: Get form simplified answers
You might need to reopen the form: Reopen form
Save the answers: Save form answers
Submit the form: Submit form

I (finally) found some pages with some examples (using web requests in Automation) that might help:

I don't have time right now to test this myself, but those last two articles from @Bruno Altenhofen have a good amount of data. Maybe he can weigh in and see if my suggestions are correct.

All comments

John Funk

Hi Iain - have you also posted this over in the Developers Community?

https://community.developer.atlassian.com/

Iain McCarthy

I have not! Was not aware that was a distinct thing, thank you - if this question seems more appropriate for that spot I will ask over there.

John Funk

I think you will get better answers over there. But leave this one here in case @Darryl Lee wants to chime in.

Darryl Lee

Hi @Iain McCarthy - the page you shared (Integrating Custom Form Fields into Jira Ticket Creation API) says:

(Experimental) Provides answers to the form associated with a request type that is attached to the request on creation.

(Emphasis mine.)

So I believe that this is only for populating a form when you are creating a NEW issue.

You said you're looking to update fields on a form. I take that to mean you're wanting to change values on forms that have already been submitted.

My reading of Forms API is that to update an existing form you would need to:

Get the IDs of all forms attached to an ticket: Get form index
Get existing answers for your form (assuming it's just one), using the formId from the step above. I think when you save answers you have to save all of them. So you'll want to get all the values that you'll need to retain or update: Get form simplified answers
You might need to reopen the form: Reopen form
Save the answers: Save form answers
Submit the form: Submit form

I (finally) found some pages with some examples (using web requests in Automation) that might help:

I don't have time right now to test this myself, but those last two articles from @Bruno Altenhofen have a good amount of data. Maybe he can weigh in and see if my suggestions are correct.

Iain McCarthy

Thanks Darryl, this is very helpful. If it is easier programatically, I have the option to add the form when I'm writing these answers, it doesn't need to pre-exist on the issue (the form addition step was done immediately prior with Jira Automation, but can be synchronous instead).

I'll have a read through the links you've provided, but if adding and submitting a form *with answers* is an easier process than an edit, this will work too.

Darryl Lee

AH yes, if it's not an Update but rather adding a new form, that's (probably) much easier:

What's weird about these APIs is that there's separate ones for Customer Requests, which seem redundant with the Issue ones, except there's no "Add form" for Requests. Curious.

Anyways though, if you're doing this programmatically, using the Issue APIs should be fine, since your script or whatever should have full permissions (as opposed to perhaps more limited Customer Request access).

BTW, if the form needs to be visible to Customers, you'll also need to:

Change visibility to external

(I think by default adding a form from the Issue side sets visibility to Internal.)

Iain McCarthy

Thanks Darryl, will try this - my only concern with doing this in one step is that dynamic data connections may not have populated fields with values needing to be set at time of creation. Will report back...

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

cloud

rest-api

automation

forms

jira-service-management-cloud

jira-service-management