getRestHttpRequest() Function

Syntax	`set aRequestObject = getRestHttpRequest()`
Semantics	Returns the request details as provided by the HTTP call. The return object is of type Base Components.Add Ons.REST.Request, which is part of the base components of the Designer. `getRestHttpRequest()` is only applicable in REST service context. In other contexts, e.g. if called via a SOAP shadow port (and thus SOAP context), `getRestHttpRequest()` will return NULL. Use getServiceContext() Function or getServiceContextValue() Function in such cases.
Substitutables	`aRequestObject`	An object of type Base Components.Add Ons.REST.Request:
Examples	CODE `set aRequestObject = getRestHttpRequest();`

Reading the REST request headers is e.g. important to implement REST service authentication.

Related Content