services keyValueRouteService

baasicKeyValueRouteService

Baasic Key Value Route Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Key Value 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.

---

baasicKeyValueRouteService.find()

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

• searchQuery - A string value used to identify key value resources using the phrase search.
• page - A value used to set the page number, i.e. to retrieve certain key value subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the key value property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

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

baasicKeyValueRouteService.get()

Parses get key value route which must be expanded with the Id of the previously created key value resource in the system.

Example:

baasicKeyValueRouteService.get.expand(
	{id: '<key-value-id>'}
);               

baasicKeyValueRouteService.create()

Parses create key value route; this URI template does not expose any additional options.

Example:

baasicKeyValueRouteService.create.expand({});              

baasicKeyValueRouteService.parse()

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

Example:

baasicKeyValueRouteService.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