Skip to main content
AskMe (beta)
Loading icon

HS.HC.SubTaskMgr.REST.Resource.Config

class HS.HC.SubTaskMgr.REST.Resource.Config extends HS.REST.Model.Proxy

Method Inventory

Parameters

parameter JSONMAPPING = RestMapping;
%JSONMAPPING specifies a class-default JSON mapping to use for object projections of other classes.
parameter MEDIATYPE = application/vnd.intersystems.com.hs.sys.read-update-polling.v1+json;
Inherited description: Content-Type implemented in this class Subclasses MAY override this
parameter RESOURCENAME = async-subtask;
Name of the resource at the REST level Subclasses MUST override this
parameter SOURCECLASS = HS.HC.SubTaskMgr.JobRecord;
The class to which this class provides REST access. It must extend %Persistent and have its %JSONENABLED class parameter set to 1 (e.g., by extending %JSON.Adaptor). Subclasses must override this parameter.

Methods

classmethod CheckPermission(pID As %String, pOperation As %String, pUserContext As %RegisteredObject, ByRef URLParams) as %Boolean
Inherited description: Checks the user's permission for a particular operation on a particular record. pOperation may be one of the macros of the form $$$Operation* present in %pkg.isc.rest.general.inc.
If this method returns 0, the corresponding dispatch class will return a 403 Unauthorized status when the operation is invoked.
pUserContext is supplied by GetUserContext().
classmethod IsPolling() as HS.HC.SubTaskMgr.REST.RestPollingResponse
classmethod Polling(pAction As %String) as HS.HC.SubTaskMgr.REST.RestPollingResponse
classmethod Supports(pOperation As %String, pType As %String(VALUELIST=",instance,class"), pRequest As %CSP.Request = $$$NULLOREF) as %Boolean
Inherited description: Checks if the particular operation is supported for this resource.
Look at documentation of SupportsDefault() for default behavior of this method.
If the method returns 0, the corresponding dispatch class will return a 404 Not Found status when the operation is invoked.
NOTE: This method runs on EVERY request so should be quick, lightweight checks to prevent performance bottlenecks.
pOperation may be one of the macros of the form $$$Operation* present in %pkg.isc.rest.general.inc.
pType is the type of the operation (instance-level on a particular record or class-level).
pRequest is the request object in an HTTP context. NOTE: MUST check that this is an object before using it as it may be passed as a NULL OREF in some cases.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab