%pkg.isc.rest.model.resource

Set to 1 to treat this resource as the default for its name. This permit flexible matching on MEDIATYPE for GET requests; e.g., given MEDIATYPE=application/json, a GET request for this resource name will match if Accept is set to */* or application/*

Content-Type implemented in this class Subclasses MAY override this

Name of the resource at the REST level Subclasses MUST override this

Security resource used to protect this REST resource.
If provided, then any READ or QUERY operations require READ access to the resource and any Create, Update or Delete operations require WRITE access to the resource.
This parameter is used in the default implementation of CheckPermission() below. If more advanced permission checking is needed, the method can be overridden.

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().

Deletes an instance of this model, based on the identifier pID

Called by the handler when serving plural get requests.

In the simplest case, the Resource is a Proxy and params are just query parameters for querying a table. Note: This method should handle exporting JSON to the current device.

Returns an instance of this model, based on the arguments supplied.

Modify the autogenerated OpenAPI Specification objects for this class by changing the values of the passed ByRef parameters @Argument schemas: List of %pkg.isc.rest.openAPI.model.schema @Argument endpoints: Array of endpoint URL -> %pkg.isc.rest.openAPI.model.pathItem (%pkg.isc.rest.openAPI.model.paths) Sample use cases: - Modify resource schema descriptions - Add additional ISC_* fields to the resource schemas - Correct resource schemas for classes that use custom JSON generation code - Remove non-desired endpoints from output - Provide alternate schemas for endpoint input / output (ie. in the case of %DynamicObject use) - Add documentation for non-standard endpoints Note: Endpoints can be removed from the endpoints array as desired, however schemas should not be removed from the schemas array.

Saves the model instance.

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.

Default implementation of Supports() which acts as a wrapper around this method.
By default, the behavior is to support all operations that have their corresponding methods implemented i.e. the methods are not abstract.