How to get param passed in GET REST query

Question

Question

Pierre LaFay · Aug 20, 2023

#REST API #InterSystems IRIS #InterSystems IRIS for Health

Hi,

I don't found how to get params send by a GET REST query (not in url but by request param).

this is config of the call in postman

I try to get %request.Data, doesn't work : Data is undefined

I try to get %request.GetCgiEnv("Data"), doesn't work, return ""

I do ZW %request and see that my parameter is present in cgi parameters, but I don't now how to access it.

Discussion (9)1

Log in or sign up to continue

Ashok Kumar · Aug 20, 2023

Hello Pierre,

You have two options to get query parameters

You can merge the entire %request.Data into local array and use string function.
User %request.Next(data) method to loop the %request.Data one by one and get query parameter values

ClassMethod GetQueryParams()
{
	set data=""
	For {
		set data  = %request.Next(data) quit:data=""
		write data,!
	}
}
OUTPUT
Bottom
Name
TopObjectScript
ObjectScript

For cgiEnvs. You can follow same merge option to get all values. Otherwise use %request.NextCgiEnv(cgi) to get the list of available values.

ClassMethod GetcgiEnvs()
{
    set cgi=""
    for {
        set cgi  = %request.NextCgiEnv(cgi) quit:cgi=""
        write cgi,!
    }
}ObjectScript
ObjectScript

0 0

Ashok Kumar Aug 21, 2023 to Pierre LaFay

Hello Pierre,

No problem. You can use the merge command(sorry not a string function) to take a copy of entire global node and subtree

merge queryparam = %request.Data
zwrite queryparam ;print the entire node and subtreeObjectScript
ObjectScript

0 0

Eduard Lebedyuk · Aug 21, 2023

To check all parts of the request you can use this utility method which outputs all objects as a response. Just add this to any part of your code:

set %response.ContentType = "html"
do ##class(%CSP.Utils).DisplayAllObjects()
return $$$OK

1 1

Chad Severtson · Aug 21, 2023

%request.Get("Top") will return the value which is stored in %request.Data("Top", 1).

If you want to iterate through all the values, I'd use @Ashok Kumar 's solution or $ORDER on %request.Data.

0 0

score 0 · Answer 1 · 2023-08-20T02:12:01-04:00

I found a way by %request.Data("Top",1), but in this case, I get parameters one by one.

Is a method to get all my parameters in an object or an array exists ?

score 0 · Answer 2 · 2023-08-21T09:00:53-04:00

Hi Ashok,

Thank you for your answer, I understand and will apply looping by Next in Data.

However, I don't know how to merge the entire %request.Data into local array and use string function.

I'm sorry for asking questions that should be obvious, but I'm new to Iris for REST Api...

score 0 · Answer 3 · 2023-08-21T10:59:21-04:00

Pierre LaFay Aug 21, 2023 to Ashok Kumar

Many thanks, works fine and it's exactly what I need

0 0

score 0 · Answer 4 · 2023-08-21T11:02:39-04:00

Pierre LaFay Aug 21, 2023 to Eduard Lebedyuk

Hi Eduard,

Thanks for this utility method. I think I will use it for debugging

0 0

score 0 · Answer 5 · 2023-08-21T11:00:11-04:00

Pierre LaFay Aug 21, 2023 to Chad Severtson

Hi Chad,

Thanks for your alternative syntax !

0 0