Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [REST] >  [v1]
Private  Storage   

class %DeepSee.REST.v1 extends %DeepSee.REST.REST

This class provides validation and dispatch for version 1 of the DeepSee REST services In general, required arguments are expected in the URL. The exceptions to this rule are /Data/MDXExecute and /Data/PivotExecute, which require an argument POSTed to the the body of the request. For some services, the client may POST additional parameters in the body of the request. The description for each service outlines the parameters accepted for that particular service. In all services, unknown parameters that are included in the request body are ignored.

Example: Execute an MDX query using an HTTP POST request, sent to a web application with Dispatch class %DeepSee.REST.v1.

		var request = {};
		var mdx = 'SELECT ' +
			  '  NON EMPTY [Product].[P1].[Product Category].Members ON 0,' +
			  '  NON EMPTY [Outlet].[H1].[Region].Members ON 1 ' +
			  'FROM [HoleFoods]'
		request.method = 'POST';
		request.user = 'user';
		request.passwd = 'pass';
		request.acceptType = 'JSON';
		request.contentType = 'JSON';
		request.body = '{"MDX":"' + mdx + '"}';
		request.callback = custom.queryCallBack
		request.async = true;
		request.url = 'http://host/port/restApplication/v1/Data/MDX';
		// run the query
		var xhr = new XMLHttpRequest();
		xhr.open(request.method,request.url,request.async);
		// kick off the request
		xhr.send(contents);
Requests may be sent to the following services:

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1


Summary

Methods
%ClassIsLatestVersion %ClassName %ConstructResponseFromArray %CreateObjectFromArray
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %ErrorToJSON
%Extends %ExtractDatasourceName %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
%ValidateRequest %WaitForProviderResults AcceptsContentType AccessCheck
ConvertParameter Decrypt DispatchMap DispatchRequest
DrawCSS3STYLE DrawHEAD DrawSTHEAD DrawSTTitle
DrawSTYLE DrawTitle DrawTitleSection Encrypt
Error EscapeHTML EscapeURL Http403
Http404 Http405 Http500 HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link Login OnErrorSetup
OnHTTPHeader OnHandleCorsRequest OnHandleOptionsRequest OnLoginPage
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreDispatch OnPreHTTP OnPreHyperEvent OnSecurityTokenPage
Page QuoteJS ReportHttpStatusCode ResolveTarget
RewriteURL SetResponseHeaderIfEmpty ShowError StartTimer
StatusToJSON StatusToProxyObject StopTimer SupportedVerbs
ThrowError UnescapeHTML UnescapeURL


Methods

• classmethod %ValidateRequest(pUrl As %String, pMethod As %String) as %Status
Verfies required Converts request body


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.