%REST.disp

class %REST.disp extends %CSP.REST

The parent class to use for the geenrated API management dispatch class.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		2

Summary

Methods
%ClassIsLatestVersion	%ClassName	%Close	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends	%GetParameter
%IncrementCount	%IsA	%New	%OriginalNamespace
%PackageName	%SetModified	AcceptsContentType	AccessCheck
ConvertParameter	Decrypt	DispatchMap	DispatchRequest
DrawCSS3STYLE	DrawHEAD	DrawSTHEAD	DrawSTTitle
DrawSTYLE	DrawTitle	DrawTitleSection	Encrypt
EncryptBroker	Error	EscapeHTML	EscapeURL
Http403	Http404	Http405	Http500
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
Link	Login	OnErrorSetup	OnHTTPHeader
OnHandleCorsRequest	OnHandleOptionsRequest	OnLoginPage	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreDispatch
OnPreHTTP	OnPreHyperEvent	OnSecurityTokenPage	Page
QuoteJS	ReportHttpStatusCode	ResolveTarget	RewriteURL
SetResponseHeaderIfEmpty	ShowError	StartTimer	StatusToJSON
StatusToProxyObject	StopTimer	SupportedVerbs	ThrowError
UnescapeHTML	UnescapeURL	mnemonicForStatusCode	outputStatus

Subclasses
%Api.IAM.v1.disp	%Api.Mgmnt.v2.disp

Methods

• classmethod AccessCheck(Output pAuthorized As %Boolean = 0) as %Status

Override AccessCheck to defer access checking until OnPreDispatch.

• classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status

This method gets called prior to dispatch of the request. Put any common code here that you want to be executed for EVERY request. If pContinue is set to 0, the request will NOT be dispatched according to the UrlMap. In this case it's the responsibility of the user to return a response.