Class %Atelier.REST

class %Atelier.REST extends %CSP.REST

This class implements a custom response format and serves as the basis for all Atelier REST APIs

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1		8

Summary

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

Subclasses
%Api.Atelier	%Api.Atelier.v1	%Atelier.v2.Utils.Macros

Parameters

• parameter DOMAIN = "%Utility";

%Atelier.REST classes are unlikely to actually define messages with $$$Text %Utility seems like a catch-all, and should have all languages defined, so the %session/%response language can be set properly.

Methods

• classmethod Http500(pE As %Exception.AbstractException) as %Status

Use our special format Http500 handler

• classmethod Page(skipheader As %Boolean = 1) as %Status

Sets the response's localization domain (something that %CSP.REST should do, in theory) and then invokes default super class behavior

• classmethod RenderResponseBody(pStatus As %Status, pMsgPart As %DynamicArray, pResPart As %DynamicObject) as %Status

Render the three-part Response Body which contains an status, console, and a result part

• classmethod ReportHttpStatusCode(pHttpStatus, pSC As %Status = $$$OK) as %Status

User our special format handler for other status codes

• classmethod ServeDoc(pDocName As %String, pStatus As %Status, pMsgArray As %DynamicArray, ByRef pResArray As %String, pTimeStamp As %String = "", pUpToDate As %Boolean, pExtensionContent As %DynamicObject) as %Status

This private helper method server wraps the message and document and returns it to the caller

• classmethod ServeXml(pDocName As %String, pStatus As %Status, pMsgArray As %DynamicArray, pStream As %Stream, pTimeStamp As %String = "") as %Status

This private helper method server wraps the message and document and returns it to the caller

• classmethod SetClientServerHash(pHash As %String)

Set the clients version of the server hash

Class Reference IRIS for UNIX 2024.1.2
Documentation Search