%pkg.isc.changehistory.rest.resource.log.v1
class %pkg.isc.changehistory.rest.resource.log.v1 extends %pkg.isc.rest.model.proxy
Expose access to change history logsMethod Inventory
- CheckPermission()
- GetCollection()
- GetDiff()
- GetFilterOptions()
- GetRecordSummary()
- Supports()
- TransformDates()
Parameters
parameter MEDIATYPE = application/vnd.intersystems.com.change-history.log.v1+json;
Inherited description: Content-Type implemented in this class
Subclasses MAY override this
parameter RESOURCENAME = change-history-log;
Inherited description: Name of the resource at the REST level
Subclasses MUST override this
parameter SOURCECLASS = %pkg.isc.changehistory.storage.log.v1;
Inherited description: 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().
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 GetCollection(ByRef URLParams, selectMode As %Integer = 0)
Override to inject security-based filtering at SQL level.
Each config class that extends %pkg.isc.changehistory.abstract must implement
CheckPermissionOnChangeHistoryFeature() to specify its required security resources.
method GetDiff() as %DynamicObject
classmethod GetFilterOptions() as %DynamicObject
Return deduplicated filter options for Username/FeatureName dropdowns.
classmethod GetRecordSummary(classname As %String, internalID As %String) as %DynamicArray
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.
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.
classmethod TransformDates(ByRef URLParams)
Helper to transform dates from YYYY-MM-DD to internal $h format
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %JSONExport()
- %JSONExportArray()
- %JSONExportToDynamicObject()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONImportArray()
- %JSONMappingInfo()
- %JSONNew()
- %JSONNewDefault()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- DeleteModelInstance()
- GetModelFromResultRow()
- GetModelInstance()
- JSONExport()
- JSONExportToStream()
- JSONExportToString()
- JSONImport()
- ModifyOpenAPIInfo()
- OnAfterSaveModel()
- OnBeforeSaveModel()
- OnGetProxyColumnList()
- SaveModelInstance()
- SupportsDefault()