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; } } }

Update a Coniforms Form via a Jira status Change

Jeremy M

This question is for Alex Medved {ConfiForms} and a follow up on Confiform Rest API to update a field value - Atlassian.

I have a Jira automation with a Webhook that is calling the updateFieldValue REST API (/rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}?query={filter} ). I am on Data Center so I'm using APRI Rest Version 1

2) When I use static values for the query and for the FV fields, the webhook works perfectly and I get a 200 value. I see that the fields change

3) The moment that I add smarttags into the webhook address, Jira returns with an "Unable to parse error". The address looks like this:

{{ServerAddress}}/rest/confiforms/1.0/updateFieldValue/{{Page}}{{FormName}}/{{Smart Value with query string}}?fv={{My Update}}

Can you walk me through procedure of being able to make the values that I am searching for dynamic.

Thank you for your help here

Accepted answers

Jeremy M

@Alex Medved {ConfiForms} and @Integration Yard : Thank you for your help on this!

Let's Mark @Integration Yard note above as the answer to this question.

All comments

Sebastian Krzewiński

@Alex Medved {ConfiForms} Please take a look on that :)

Alex Medved {ConfiForms}

Sorry, I cannot tell much, as I have no idea what are the those {{Smart Value with query string}} and how they are evaluated and set (and when)

ConfiForms REST API expects the expression to be already evaluated into a value

Sebastian Krzewiński

@Jeremy M I think that I found issue.

In your {{ServerAddress}}/rest/confiforms/1.0/updateFieldValue/{{Page}}{{FormName}}/{{Smart Value with query string}}?fv={{My Update}} there is missing "/" between {{Page}} and {{FormName}} values.

Please check it if this solve issue.

Regards,

Seba

Jeremy M

@Sebastian Krzewiński Thank you for getting back to me so quickly. I checked the actual code and the the "/" is there. (Good catch by the way on the punctuation

@Alex Medved {ConfiForms}) Thank you for your time and patience here.

More explination is below

Smart values are not allowed inside the URL query string. So for example, what I am trying to do is the following:

Access the Coniforms REST Service (This works!)

The following address works, when I enter the information directly

[ServerAddress]/rest/confiforms/1.0/updateFieldValue/[My Page Number]/[My Form Name]/Foo:1&Status:OK?fv=Bar:2

(I have the correct names for the Server address, page number and form names)

2) Be able to dynamically use smart values for the values of each of the lookup fields

[ServerAddress]/rest/confiforms/1.0/updateFieldValue/[My Page Number]/[My Form Name]/Foo:{{foo}}&Status:{{status}}?fv=Bar:2

So the fields for status and foo can change since the service is being called within a Jira Branch. Smart values are not allowed in the webhook address. Dr. Google suggests sending the values as JSON using the Custom field to send the fields to the service. What I'm asking for is what is the correct way of passing the smart values into the web service so that the web service is activated correctly.

Thank you!

Alex Medved {ConfiForms}

But how should the REST API know anything about "smart values"!? It does not… and it could not

Jeremy M

@Alex Medved {ConfiForms} Thank you for bearing with me. I'm the one who is not being clear enough.

I know that I can't use the following address in the Webhook address, since Jira will not resolve the smartvalues

[ServerAddress]/rest/confiforms/1.0/updateFieldValue/[My Page Number]/[My Form Name]/Foo:{{foo}}&Status:{{status}}?fv=Bar:2

Jira Automation does not resolve the the smartvalues into something that the webservice can actually use. So using Smartvalues is out of the question here. There is a Jira request for this item that is in their backlog.

My question here is if we can use the Custom Data screen to pass the variables and how that look like for this webservice. This Technique does work for the confiforms/1.0/search/ webservice.

According to my reading you can pass variables through the following using JSON. So my question what would that look like, (if this is posssable) so I can pass through the varabiles on to the webservice properly

Alex Medved {ConfiForms}

What is this "custom data"?
Search API does support POST -

https://wiki.vertuna.com/spaces/CONFIFORMS/pages/70582777/ConfiForms+Server+REST+API+version+1#ConfiFormsServerRESTAPIversion1-SearchConfiFormsEntriesbyfilter

and you can pass your fields as form-data fields

Jeremy M

@Alex Medved {ConfiForms} Inside of the Send Webhook automation, there is a The Webhook Body, that can have a value of custom. This is where any JSON would need to be added (That does allow for a Smart Value)

The question I have is that can I use this field to send values using the PUT option.

Integration Yard

Hi @Jeremy M, on the PUT question: yes, the Custom data body in Send web request is sent for PUT as well as POST, and smart values in the body are resolved. So you can keep the URL static, set the header Content-Type: application/x-www-form-urlencoded, and send something like query={{filterQuery.urlEncode}}&fv={{fvValue.urlEncode}} as the body. @Alex can confirm whether updateFieldValue reads body parameters on PUT or only on POST.

If you'd rather keep the values in the URL: smart values *are* evaluated there, but unencoded :, & or spaces break the request ("Unable to parse"). Build the string in a Create variable action first, then use {{filterQuery.urlEncode}} in the URL. Add a Log action with {{filterQuery}} so the audit log shows exactly what gets sent.

Jeremy M

We are close

Create varaibles for the query string and the fv string using the filter format provided by coniforms, i.e foo:{{foo}}&status:{{status}}. Do the same for the fv filters you want to update
Add the the smart values using the suggestions above

[ServerAddress]/rest/confiforms/1.0/updateFieldValue/[My Page Number]/[My Form Name]{{query.urlEncode}}?fv=Bar:2

I'm still getting the errors sending the webservice— since as @alex has pointed out — we need to be in the right format!

Foo%3AValue%26Status%3AOpen%26

This is causing the webserivce to return an error that it can't find the variables, since the first part is being escaped. Is there anything that I need to replace so the webservice can see the value in the right format?

Thanks!

Integration Yard

@Jeremy M nearly there. Two small changes:

Give each value its own parameter name, and only encode the value. The & between parameters has to stay a real &; when it's inside the variable and gets url-encoded it becomes %26, so ConfiForms sees one long value instead of two parameters. Build the URL like this:
[ServerAddress]/rest/confiforms/1.0/updateFieldValue/[PageId]/[FormName]?query={{query.urlEncode}}&fv={{fv.urlEncode}}
Keep & out of the variables. query should hold just the filter, e.g. foo:{{foo}} (if you need several conditions, use the ConfiForms filter syntax for combining them; @Alex can confirm the exact form). fv holds just Bar:2.

The encoded : (%3A) inside a value is fine: the server decodes it back before ConfiForms reads it. If it still fails, add a Log action with the full URL and compare it with a request that works from Postman or curl. The audit log shows exactly what Jira sent.

Jeremy M

@Alex Medved {ConfiForms} and @Integration Yard : Thank you for your help on this!