%SYS.REST

Class %SYS.REST Extends %RegisteredObject [ System = 4 ]

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

Methods

GetCurrentRESTApplications

ClassMethod GetCurrentRESTApplications(requestNamespace As %String) As %DynamicArray

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.

GetRESTApplications

ClassMethod GetRESTApplications() As %DynamicArray

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.

GetRESTApplication

ClassMethod GetRESTApplication(webApplication As %String) As %DynamicObject

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.

DeployApplication

ClassMethod DeployApplication(restApplication As %String, webApplication As %String, authenticationType As %String) As %Status

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 application.
If the web application does not exist, then create a new web application to deploy the REST application.

ListRESTApplications

ClassMethod ListRESTApplications(namespace As %String = "", Output RESTList) As %Status [ Internal ]

Get a list of REST applications. The list is returned as a local array: RESTList(namespace,applicationName)=""

GetCSPApplication

ClassMethod GetCSPApplication(namespace As %String, applicationName As %String) As %String

Get the name of the CSP application associated with the specified REST application.

DeleteCSPApplication

ClassMethod DeleteCSPApplication(namespace As %String, applicationName As %String, ByRef exist As %Integer = 0) As %Status [ Internal ]

Delete the CSP application associated with the specified REST application