Skip to main content

%REST.Application

Class %REST.Application Extends (%RegisteredObject, %JSON.Adaptor) [ System = 4 ]

%REST.Application describes a REST application.

Properties​

name​

Property name As %String(MAXLEN = "");

The name of the REST application either in the form of a web application name or package for REST specification class name.

webApplications​

Property webApplications As %String(MAXLEN = "");

a comma separated list of the web application that the REST application is deployed to.

dispatchClass​

Property dispatchClass As %String(MAXLEN = "");

The name of the dispatch class for this REST application.

namespace​

Property namespace As %String(MAXLEN = "");

The namespace in which this application is defined.

resource​

Property resource As %String(MAXLEN = "");

Resource which is required for this application of the form resource:mode.

swaggerSpec​

Property swaggerSpec As %xsd.anyURI;

A URL to produce a swagger specification for this application.

enabled​

Property enabled As %Boolean;

This application is enabled if the enabled property is true.