Home > Class Reference > %SYS namespace > %SYS.REST

%SYS.REST

class %SYS.REST extends %Library.RegisteredObject

The %SYS.REST class contains the REST API Management utility code which must be run in the %SYS namespace.

Method Inventory

Methods

classmethod DeployApplication(restApplication As %String, webApplication As %String, authenticationType As %String) as %Status [ Language = objectscript ]
Replace any web application deployments of the specified REST application with a deployment to the specified web application.
If the web application already exists, then modify the web application to deploy this RESP applicaiton.
If the web application does not exist, then create a new web application to deploy the REST application.
classmethod GetCSPApplication(namespace As %String, applicationName As %String) as %String [ Language = objectscript ]
Get the name of the CSP application associated with the specified REST application.
classmethod GetCurrentRESTApplications(requestNamespace As %String) as %DynamicArray [ Language = objectscript ]
Return a dynamic Array of dynamic objects that define the top level entry points into legacy REST applications in the specified namespace.
The fields of the each returned object are:
Name: web application name (url prefix)
Dispatch Class : Subclass of %CSP.REST that services (the top level of) this app
Namespace : Default namespace for this app (and its dispatch class)
Enabled : Indicates that this item is enabled.
Resource : Resource used to control access for this app.

classmethod GetRESTApplication(webApplication As %String) as %DynamicObject [ Language = objectscript ]
Return a dynamic object that defines the specified legacy REST application.
The fields of the returned object are:
Name: web application name (url prefix)
Dispatch Class : Subclass of %CSP.REST that services (the top level of) this app
Namespace : Default namespace for this app (and its dispatch class)
Enabled : Indicates that this item is enabled.
Resource : Resource used to control access for this app.

classmethod GetRESTApplications() as %DynamicArray [ Language = objectscript ]
Return a dynamic Array of dynamic objects that define the top level entry points into all legacy REST applications which are accessible to the current user.
The fields of the each returned object are:
Name: web application name (url prefix)
Dispatch Class : Subclass of %CSP.REST that services (the top level of) this app
Namespace : Default namespace for this app (and its dispatch class)
Enabled : Indicates that this item is enabled.
Resource : Resource used to control access for this app.

Inherited Members

Inherited Methods