services dynamicSchemaRouteService

baasicDynamicSchemaRouteService

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

---

baasicDynamicSchemaRouteService.find()

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

• searchQuery - A string referencing dynamic resource schema properties using the phrase or BQL (Baasic Query Language) search.
• page - A value used to set the page number, i.e. to retrieve certain dynamic resource schema subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the dynamic resource schema property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

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

baasicDynamicSchemaRouteService.get()

Parses get route which must be expanded with name of the previously created dynamic resource schema. Additional expand supported items are:

• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicDynamicSchemaRouteService.find.expand(
	{name: '<schema-name>'}
);               

baasicDynamicSchemaRouteService.generate()

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

Example:

baasicDynamicSchemaRouteService.create.expand({});              

baasicDynamicSchemaRouteService.create()

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

Example:

baasicDynamicSchemaRouteService.create.expand({});              

baasicDynamicSchemaRouteService.parse()

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

Example:

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