How to pass parameters for a newly configured API Query component?

Hi Experts,

I've configured a new API Query profile and using it in a API Query component of a job. The API get call configured in this query profile is retrieving entire dataset (of all IDs) from the source. And this dataset set will grew over time and will hit the governance limit set at the source system. So our source system is suggesting to apply filter on the IDs while making the API call.

So the solution we are thinking of is to make an initial API call that will fetch all the ID numbers from source.

Then we want to make another API call by passing a set of IDs as parameters and then iterating over this component until all the IDs data is extracted.

So we want to know how can ​we pass IDs as parameters to the API profile.

Thank you,

Vinod.​

Hi Vinod,

 

good news: That's quite easy to do! In your API Query profile, you can access variable in the "connection" object as follows:

 

<api:set attr="URI" value="https://[...]/devices/v1?ids=[_connection.host_id]" />"

 

In your Orchestration job, choose the API Query component for your Query profile and set the property "Connection Options" as follows:

 

Paramter is “Other” and in this case, host_id is the variable as used in the API Query profile which is assigned with ${v_host_id} which is a METL job variable. Mind the “;” at the end of the line!

 

Have fun

Michael

Excellent, It is also helpful for me.

 

Thanks Michael