How to change BVMS camera names (bulk operation) using the REST API based configuration interface?

REST API: For Configuration purpose (first step: camera re-naming)

A Configuration API in general allows to configure BVMS using a REST API.

The introduction of the feature will be done step by step.

The first step includes the following functionality: Batch Rename of Cameras

-Exporting list of cameras (GET Camera name, IP-Address, Camera Id)

-Renaming cameras (SET/UPDATE)

-Activate changes, by triggering the activation manager (POST)

Why is Batch renaming required for which use cases? 

-Batch renaming of Cameras enables the possibility of a customer to implement a certain camera schema for all the cameras on one or multiple BVMS systems, on one or multiple sites, to allow the Operators to interpret the camera names in a unique way.

-The naming schema can change from time to time, the Configuration API allows for easy updates of the camera names.

-Several BVMS systems were deployed on different sites over years. A unique camera naming schema was not applied on every site. This results into different camera naming in every site.

Who is creating the REST API script?

-The creation of the batch file to execute using the REST API is in the hands of the BVMS System integrators or End-customer administrators.

Note

The Configuration API can only be used if Configuration Client and Configuration Wizard is logged off!

BVMS installation setup

The setup offers an option to deploy the REST endpoint as an optional feature “Server API" as sub-feature of the Management Server (disabled by default)

The setup configures a corresponding firewall rule for the endpoint only if the "Configuration API" feature is installed.

The exact port of the REST endpoint service: 5399

Name of service in service manager: BVMS Server API

There is a dedicated log file for the API available.  

User group permissions required for non Admin users

Admin user (admin group) holds all permissions by default.

Non-Admin users who want to connect to the configuration API must have configuration permissions on the user group

REST API for Configuration purpose: Access permissions

Admin user (admin group) holds all permissions by default.

Non-Admin users who want to connect to the configuration API must have configuration permissions on the user group

REST API for Configuration purpose: Activation Manager

•  The user can trigger an activation of the configuration via the REST API 

•  The user can specify a comment for the activation:

  • The comment must not be empty

  • In front of the comment the following text will appear by default: “REST Api:”

• The user can specify whether the Operator Clients are forced to use the newly activated configuration (force OC logout).    Default value: not forced

• If the activation trigger request cannot be accepted (E.g., logged on user has no permissions), a specific error message is shown. (permissions, server down, service not reachable, etc.)

• When the latest configuration exceeds the license limits (or license is not active/missing) then the REST API shows an appropriate error and does not trigger the activation.

Documentation: Configuration API

Intended users of the REST API are most probably 3rd party developers rather than BVMS Configuration Client users (Administrators).

Therefore, the documentation is not implemented in the Configuration Client. It is available as file in the file directory to be opened in a .yaml editor:

1.Go to the following web page, an online editor is offered: https://editor.swagger.io/

2.Select File → Import file and choose the following directory from the BVMS installation folders:
C:\Program Files\Bosch\VMS\Doc\APIs\............API\........api.yaml

If the path does not exist, the option “Configuration API” (within Management server feature options) was not chosen/installed during BVMS installation in the setup file.