Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %REST.RESTSpec
Private  Storage   

%REST.RESTSpec


Super class for classes which describe a RESTSpec This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8


Summary


Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %JSONExport
%JSONExportToStream %JSONExportToString %JSONImport %JSONNew
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject GetClassModel GetSpecificationXData XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType

Subclasses

Parameters


• parameter XMLFORMAT = "literal";
The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport methods for XML enabled classes to include code for only literal or only encoded format. This allows the generated routines to be significantly smaller since usually both formats are not needed.
If XMLFORMAT="Literal", then only support for literal format import and export is generated.
If XMLFORMAT="Encoded", then only support for SOAP encoded format import and export is generated.
The default is to generate support for both literal and encoded format.

Methods


• classmethod GetClassModel(specClassName As %String, xdataName As %String, Output spec As %REST.RESTSpec.RESTSpecObject, Output internalError As %Boolean) as %Status
Return the RESTSpec xdata block as a tree of correlated classes.
• classmethod GetSpecificationXData(specClassName As %String, xdataName As %String, Output xdata As %Dictionary.XDataDefinition) as %Status
Return the OpenAPI xdata block.