Sections of a resource access file
Every resource access file contains a list of resources.
Resources can be named in the singular (such as Activity) or in the plural
(such as Activities).
When a resource is named in the singular, the information that follows applies to
endpoints that return individual elements of that resource type. This includes endpoints whose
operations are GET (for a single element), POST (for custom business actions), PATCH, and
DELETE. For individual elements, there can be only one sections:
permissions.
When a resource is named in the plural, the information that follows applies to
endpoints that return collections of that resource type. This includes endpoints whose
operations are GET (for a collection) and POST. For collections, there can be two sections:
permissions and filters.
There are different types of access information you can specify for a resource type:
-
permissions- Defines actions that the caller can take on accessible resources, such as
viewand edit -
Can be specified for both element and collection resources
- Defines actions that the caller can take on accessible resources, such as
-
filters-
Defines criteria that the resource must meet to be accessible to the caller
-
Can be specified for both collection resources only
-