%Api.DeepSee
class %Api.DeepSee extends %CSP.REST
Routing class for the DeepSee REST servicesMethod Inventory
Parameters
parameter CHARSET = utf-8;
Specifies the default character set for the page. This can be overriden using the
<CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property
in the OnPreHTTP() method. If this parameter is not specified, then
for the default charset is utf-8.
parameter CONTENTTYPE = application/json;
Specifies the default content type for the page. This can be overriden using the
<CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property
in the OnPreHTTP() method. The default value if this parameter is
not set is text/html.
parameter HandleCorsRequest = 1;
This parameter influences the CORS support. The default is an empty string meaning 'not specified'.
If set to true (1) then CORS processing is ON. If set to false (0) then CORS processing is OFF.
If left unset "" then the decision to process CORS is delegated to the setting on the URL map route.
Methods
This method performs a basic access check. You can override this to add additional checks
classmethod DeleteAppConfig(pUserName) as %Status
A user with %DeepSee_Admin privileges may remove a configuration for any named user using
DELETE http://host/application/v1/Config/username
classmethod GetAppConfig() as %Status
Fetch an application configuration available through the base application pointing to this library as its dispatch class. This
is available prior to the redirect to a specific namespace.
classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status
This method Gets called prior to dispatch of the request. Put any common code here
that you want to be executed for EVERY request. If pContinue is set to 0, the
request will NOT be dispatched according to the UrlMap. In this case it's the
responsibility of the user to return a response.
classmethod SetAppConfig() as %Status
This method is responsible for setting a custom application configuration in the form of a JSON document into a user-specific storage location.
To set an application configuration, use
POST http://host/application/v1/ConfigThe stored configuration may be any valid JSON document submitted under the CONFIG property of the posted payload. This will be stored for the current user by default. Optionally, a user with admin privileges may assign a configuration to a specific user.
{ "USERNAME":"jsmith", "CONFIG":{"NameSpace":"USER", "Last":"MyStats.dashboard"} }A default configuration may be defined for all users that have not had specific configurations defined by setting the user to %DEFAULT. If a configuration is requested for a user who has none defined, and no default is defined, then the return is the null string.
classmethod WriteNamespaceList() as %Status
This method returns a list of namespaces for this server.
HTTP 200 if OK
HTTP 500 if an error occurs (details will be in status error array)
Returned content is an array of IRIS BI enabled namespaces the current user may access, for example:
GET http://host/api/deepsee/v1/NamespacesHTTP Codes returned:
HTTP 200 if OK
HTTP 500 if an error occurs (details will be in status error array)
Returned content is an array of IRIS BI enabled namespaces the current user may access, for example:
{ "Info": { "Error": "" }, "Result": [ "SAMPLES", "TEST", "USER" ] }
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- AcceptsContentType()
- ConvertParameter()
- Decrypt()
- DispatchRequest()
- DrawCSS3STYLE()
- DrawHEAD()
- DrawSTHEAD()
- DrawSTTitle()
- DrawSTYLE()
- DrawTitle()
- DrawTitleSection()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- GetAuthChallenge()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- Login()
- OnErrorSetup()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnLoginPage()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- OnSecurityTokenPage()
- Page()
- QuoteJS()
- ReportHttpStatusCode()
- RewriteURL()
- SetResponseHeaderIfEmpty()
- ShowError()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()