Returning a 401 using %REST.Impl

Question

Question

Hello

I am trying to convert some old rest classes using the OpenApi spec (e.g. %REST.Impl)

Say I want to return a 401 in my impl.cls for api and I can define the status code as follows, e.g.

 Do ..%SetStatusCode("401")
 Do ..%SetContentType("application/json")

However the api client will see this as 401 OK which is not right.

In the past, I could just create a rest class that extends from %CSP.REST and return as follows:

Set %response.Status = ..#HTTP401UNAUTHORIZED

This will return 401 Unauthorized, which what I expect to see reported in the api client.

How this possible to achieve the same behaviour %REST.Impl? I can't see a method that supports this.

Thanks

Dan

Product version: IRIS 2023.1

$ZV: IRIS for Windows (x86-64) 2023.1.3 (Build 517U) Wed Jan 10 2024 13:36:58 EST

Discussion (3)2

Log in or sign up to continue

Brett Saviano · Mar 27

@Daniel Bertozzi
You can do the following:

 Do ..%SetStatusCode(##class(%CSP.REST).#HTTP401UNAUTHORIZED)

0 0

score 0 · Answer 1 · 2024-03-27T09:31:28-04:00

When you see something that starts with a ..# that's a parameter that's defined in a class. If you look at the source of the %CSP.REST class, you'll see:

Parameter HTTP401UNAUTHORIZED As %String = "401 Unauthorized";

So you could try either set the %response.Status "401 Unauthorized" or add that parameter to your class and use it as you have before in %CSP.REST classes.

score 0 · Answer 2 · 2024-04-02T04:30:03-04:00

Using %CSP.REST class to get value will work. It's a bit weird that %REST.Impl does not have this out of the box though. My guess there's probably an expectation to have an IAM in front of this (e.g. Kong or MS Azure)