REST Class Reference

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

Inheritance diagram for REST:

Collaboration diagram for REST:

Static Public Member Functions
_.Library.Status	DeployApplication (_.Library.String restApplication, _.Library.String webApplication, _.Library.String authenticationType)
	The SYS.REST class contains the REST API Management utility code which must be run in the SYS namespace. More...
_.Library.String	GetCSPApplication (_.Library.String namespace, _.Library.String applicationName)
	Get the name of the CSP application associated with the specified REST application.
_.Library.DynamicArray	GetCurrentRESTApplications (_.Library.String requestNamespace)
	Return a dynamic Array of dynamic objects that define the top. More...
_.Library.DynamicObject	GetRESTApplication (_.Library.String webApplication)
	Return a dynamic object that defines the specified legacy REST application. More...
_.Library.DynamicArray	GetRESTApplications ()
	Return a dynamic Array of dynamic objects that define the top. More...

Detailed Description

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

Member Function Documentation

DeployApplication()

_.Library.Status DeployApplication ( _.Library.String  restApplication, _.Library.String  webApplication, _.Library.String  authenticationType  )

static

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

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.

GetCurrentRESTApplications()

_.Library.DynamicArray GetCurrentRESTApplications ( _.Library.String  requestNamespace )

static

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.

GetRESTApplication()

_.Library.DynamicObject GetRESTApplication ( _.Library.String  webApplication )

static

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.

GetRESTApplications()

_.Library.DynamicArray GetRESTApplications ( )

static

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.