topic Re: Hand-over parameters in API call to Analytical App in Alteryx Server Discussions

Hand-over parameters in API call to Analytical App

M-Kuch — Thu, 07 Jul 2022 16:42:33 GMT

Hi experts,

I need to execute an analytical application via a webservice call and hand over three parameters which are mandatory filter parameters in this executed workflow/analytical app.

In order to test such a setup initially I created a minimal analytical app and placed it on the server. This works perfectly fine when triggering it manually.

Starting the workflow via API call also works, the workflow then runs without any input parameters.

I am now struggling with a handover of a filter parameter. In my test case I want to filter the input table on the dimension “period_ID” with the value “12.2013”.

I am using the following API: POST /user/v2/workflows/{appId}/jobs

As far as I interpret the “values” section, I tried to provide the parameters with the following syntax:

I also tried using Postman, with the same result (workflow runs with an empty selection, only returning the dimensions of the result table).

Is my requirement even implementable with the API? If yes, does anybody have any experience with the correct syntax of the parameter handover?

Please find further screenshots attached below.

Looking forward to your reply as this is quite an exciting feature and one of the last tiles in our integration puzzle.

We are on Version 2021.4.1.04899

Thanks and best regards,
Max

Re: Hand-over parameters in API call to Analytical App

fmvizcaino — Tue, 12 Jul 2022 14:50:16 GMT

Hi @M-Kuch ,

For the questions, you have two options:

1. Use an endpoint to retrieve the tool name so you can use it.

2. Way easier, to go to the tool configuration tab and annotations and get the name from there, you can also rename to an easier name if you want to.

It took me a while to figure out the priority also, luckily I've found a reply somewhere showing what to include there. You need to use numbers there and I'm almost sure it is related to the QoS, as the image below. You can also disregard the whole line and just delete it from the body

Best,

Fernando Vizcaino

Re: Hand-over parameters in API call to Analytical App

shravan_ds — Thu, 16 Mar 2023 17:35:59 GMT

We are also facing the same issue, where we are passing the parameters in the postman but the workflow runs without the passed values.

Re: Hand-over parameters in API call to Analytical App

fmvizcaino — Mon, 20 Mar 2023 19:53:22 GMT

Hey @shravan_ds ,

Could you please share the body you are sending?

Best regards,

Fernando Vizcaino

Re: Hand-over parameters in API call to Analytical App

Jérémie — Sun, 07 Jan 2024 21:47:51 GMT

Hello @M-Kuch !

I was wondering if you were able to solve your issue, and if yes the way you did it

Kind regards,

Mistralou

Re: Hand-over parameters in API call to Analytical App

Arti2893 — Wed, 10 Apr 2024 13:25:06 GMT

Do we have any sample workflow and API used for this?
I am looking for something similar so need help