services permissionsRouteService

baasicPermissionsRouteService

Baasic Permissions Route Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Permissions Route Service to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.

---

baasicPermissionsRouteService.find()

Parses find route which can be expanded with additional options. Supported items are:

• section - Section abbreviation which identifies part of the application for which security privileges can be retrieved and managed.
• searchQuery - A string value used to identify access policy resources using the phrase search.
• sort - A string used to set the access policy property to sort the result collection by.

Example:

baasicPermissionsRouteService.find(
	'sectionName'
).expand(
	{searchQuery: '<search-phrase>'}
);               

baasicPermissionsRouteService.getActions()

Parses getActions route which can be expanded with additional options. Supported items are:

• searchQuery - A string value used to identify access action resources using the phrase search.
• sort - A string used to set the access action property to sort the result collection by.

Example:

baasicPermissionsRouteService.getActions.expand(
	{searchQuery: '<search-phrase>'}
);               

baasicPermissionsRouteService.getRoles()

Parses getRoles route which can be expanded with additional options. Supported items are:

• searchQuery - A string value used to identify access policy resources using the phrase search.
• sort - A string used to set the access policy property to sort the result collection by.
• page - A value used to set the page number, i.e. to retrieve certain access policy subset from the storage.
• rpp - A value used to limit the size of result set per page.

Example:

baasicPermissionsRouteService.getRoles.expand(
	{searchQuery: '<search-phrase>'}
);               

baasicPermissionsRouteService.getUsers()

Parses getUsers route which can be expanded with additional options. Supported items are:

• searchQuery - A string value used to identify access policy resources using the phrase search.
• sort - A string used to set the access policy property to sort the result collection by.
• page - A value used to set the page number, i.e. to retrieve certain access policy subset from the storage.
• rpp - A value used to limit the size of result set per page.

Example:

baasicPermissionsRouteService.getRoles.expand(
	{searchQuery: '<search-phrase>'}
);               

baasicPermissionsRouteService.create()

Parses create permission route; this URI template doesn't expose any additional properties.

Example:

baasicPermissionsRouteService.create.expand({});               

baasicPermissionsRouteService.tags.parse()

Parses and expands URI templates based on RFC6570 specifications. For more information please visit the project GitHub page.

Example:

baasicPermissionsRouteService.parse(
	'<route>/{?embed,fields,options}'
).expand(
	{embed: '<embedded-resource>'}
);

---

Notes:

• Refer to the Baasic REST API for detailed information about available Baasic REST API end-points.
• URI Template syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
• All end-point objects are transformed by the associated route service.

(c) 2017 Mono Ltd

Author: Mono Ltd

License: MIT