Property Parameters - Used in REST calls

Question

Question

Scott Roth · Oct 31, 2018

#API #Beginner #Business Operation #Object Data Model #REST API #Ensemble

I am working on my first REST operation concept and had a question about the Property Parameters. If I put a value in CAPTION, does that mean that when I use it in my call that it will come out in the URL?

For example...

Property enumerationType As %String(CAPTION = "enumeration_type");

Then in my operation...

Set tURL=..Adapter.URL_"?q="_pRequest.enumerationType

so when it builds the URL it looks like...

Discussion (3)2

Log in or sign up to continue

Eduard Lebedyuk · Nov 10, 2018

You need so specify your base URL as URL property and pass the parameters in a method:

 set sc = ..Adapter.Get(.httpResponse, "key,key2", "value", "value2")

It would send the following request:

GET /baseURL?key=value&key2=value2 HTTP/1.1

0 0

score 0 · Answer 1 · 2018-11-09T15:34:15-05:00

Scott Roth · Nov 9, 2018

Just following up, can anyone answer my question above?

0 0

score 0 · Answer 2 · 2018-11-09T16:14:45-05:00

CAPTION values won't be added to the URL automatically. The result of the sample code you posted would be:
https://npiregistry.cms.hhs.gov/api?q=NPI-1

CAPTION is generally used to set the label text for a property when displaying it in a user interface. It's used extensively in Zen:
https://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY...