If-conditional inside a loop to obtain an element from a list in a JSON web response

Question

I'm trying to write an automation that uses a previously-defined variable, say {{specialClientId}}, to fetch other important data about this client from an online database. I'm having a bit of a problem with the variable scope inside the inner conditional.

In particular, I make a web request to an API endpoint that provides an output like this:

{"result": [

{"clientId": clientId1,

"clientFavAnimal": clientFavAnimal1,

etc},

{"clientId": clientId2,

"clientFavAnimal": clientFavAnimal2,

etc},

...

]

}

I want to extract the clientFavAnimal associated to my {{specialClientId}} variable.

My approach right now is to place a conditional inside a loop that iterates through the webResponse.body result, like so:

In my testing, this works perfectly if I write in the specialClientId explicitly, but this results in blank output when written as above. This makes sense to me because {{specialClientId}} is inside the loop, and so Jira thinks I'm referencing a key inside the webResponse result. How do I make the scope of the variables inside the conditional explicit so that the correct values are compared?

Bill Sheboy · Answer

My understanding is the Atlassian team has attempted to address this iterator limitation in the automation engine several times without success.

You could also create a service external to the rule, passing your client ID to perform the lookup / filtering there and return the result to the rule.

IL_t8q18o · Answer

The idea of treating pieces of the JSON object as a string and using matches is definitely not ideal, but thanks for giving it a shot Bill. It's too bad that the iterators can't natively handle what seems to be a pretty typical use-case of iteration. It seems like it would be easy to fix, e.g. prepending a period mark before smart values in the iteration that are meant to refer to properties of the iterated object, a la VBA.

Bill Sheboy · Answer

Hi @IL

This is a known limitation of automation rule iterators: once inside the scope of the iterator, it cannot access data / smart values at any higher / other level.

And so your variable specialClientId is not visible inside of the iterator {{#webResponse}} ... {{/}}

Depending upon what is needed, there are a couple of workarounds:

* When parallel processing is acceptable, use an advanced branch over the webResponse smart values and add conditions to select what is needed for action.  This appears to be what you are using.
* Use created variables and a dynamic regular expression with the match() function with inline iteration

This second method can be challenging to get correct.  The essential steps are:

* Iterate over the {{webResponse}} to create a text variable in a known, delimited format.  Let's assume that is named varWebResponse to avoid name collisions, and that the record delimiter is "~~"
* Create another variable for the regular expression, perhaps built with your variable.  Let's assume that is named varRegularExpression, and perhaps contains this:* ({\"clientId\": {{specialClientId}}.*)

* Split apart your first variable and use match() to find the record needed:* {{varWebResponse.split("~~").match(varRegularExpression)}}

* Use text functions on the result of the above match() to extract your field, clientFavAnimal

Kind regards,
Bill