services mediaVaultRouteService

baasicMediaVaultRouteService

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

---

baasicMediaVaultRouteService.find()

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

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

Example:

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

baasicMediaVaultRouteService.get()

Parses get route; this route should be expanded with the Id of media vault resource.

Example:

baasicMediaVaultRouteService.get.expand(
    {id: '<media-vault-id>'}
);               

baasicMediaVaultRouteService.streams.get()

Parses get route; this route should be expanded with id or path of desired media vault stream. Additional supported items are:

• width - width of desired derived image.
• height - height of desired derived image.

Example:

baasicMediaVaultRouteService.streams.get.expand(
    {id: '<path>'}
);               

baasicMediaVaultRouteService.streams.create()

Parses create route; this route should be expanded with the path which indicates where the stream will be saved.

Example:

baasicMediaVaultRouteService.streams.create.expand(
    {path: '<path>'}
);               

baasicMediaVaultRouteService.streams.update()

Parses update route; this route should be expanded with the id or path of the previously saved media vault resource. Additional supported items are:

• width - width of desired derived image.
• height - height of desired derived image.

Example:

baasicMediaVaultRouteService.streams.update.expand(
    {id: '<path>'}
);               

baasicMediaVaultRouteService.batch.remove()

Parses remove route; this URI template does not expose any additional options.

Example:

baasicMediaVaultRouteService.batch.remove.expand({});              

baasicMediaVaultRouteService.batch.update()

Parses update route; this URI template does not expose any additional options.

Example:

baasicMediaVaultRouteService.batch.update.expand({});              

baasicMediaVaultRouteService.settings.get()

Parses get route; this route doesn not expose any additional options.

Example:

baasicMediaVaultRouteService.settings.get.expand({});               

baasicMediaVaultRouteService.settings.update()

Parses update route; this URI template does not expose any additional options.

Example:

baasicMediaVaultRouteService.settings.update.expand({});              

baasicMediaVaultRouteService.processingProviderSettings.find()

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

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

Example:

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

baasicMediaVaultRouteService.processingProviderSettings.get()

Parses get route; this route should be expanded with Id of the media vault processing provider setting resource.

Example:

baasicMediaVaultRouteService.processingProviderSettings.get.expand(
    {id: '<id>'}
);               

baasicMediaVaultRouteService.parse()

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

Example:

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

---

Notes:

• Refer to the REST API documentation 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.