Scripts are provided with the following scope.
{
"openidm": openidm-functions object,
"request": resource-request object,
"response": resource-response object,
"exception": exception object
}- "openidm"
-
openidm-functions object
Provides access to OpenIDM resources.
- "request"
-
resource-request object
The resource-request context, which has one or more parent contexts. Provided in the scope of
"condition","onRequest","onResponse"and"onFailure"scripts. - "response"
-
openidm-functions object
The response to the resource-request. Only provided in the scope of the
"onResponse"script. - "exception"
-
exception object
The exception value that was thrown as a result of processing the request. Only provided in the scope of the
"onFailure"script.
An exception object is defined as follows.
{
"error": integer,
"reason": string,
"message": string,
"detail": string
}- "error"
-
integer
The numeric code of the exception.
- "reason"
-
string
The short reason phrase of the exception.
- "message"
-
string
A brief message describing the exception.
- "detail"
-
(optional), string
A detailed description of the exception, in structured JSON format, suitable for programmatic evaluation.
