All of the endpoints in the Role REST API are inherited from the generic PersistedModel REST API. The reference is provided here for convenience.
Quick reference
URI Pattern | HTTP Verb | Default Permission | Description | Arguments |
---|---|---|---|---|
| POST | Allow | Add role instance and persist to data source. Inherited from generic model API. | JSON object (in request body) |
/roles | GET | Deny | Find all instances of role that match specified filter. Inherited from generic model API . | One or more filters in query parameters:
|
/roles | PUT | Deny | Update / insert role instance and persist to data source. Inherited from generic model API . | JSON object (in request body) |
/roles/id | GET | Deny | Find role by ID: Return data for the specified role instance ID. Inherited from generic model API . | id, the role instance ID (in URI path) |
/roles/id | PUT | Deny | Update attributes for specified role ID and persist. Inherited from generic model API . | Query parameters:
|
/roles/id | DELETE | Deny | Delete role with specified instance ID. Inherited from generic model API . | id, role ID (in URI path) |
/roles/id/exists | GET | Deny | Check instance existence: Return true if specified role ID exists. Inherited from generic model API . | URI path:
|
/roles/count | GET | Deny | Return the number of role instances that matches specified where clause. Inherited from generic model API. | Where filter specified in query parameter |
/roles/findOne | GET | Deny | Find first role instance that matches specified filter. Inherited from generic model API . | Same as Find matching instances. |