Users Manual

As an example, the rc
_
stereomatching parameters can be retrieved using
curl -X GET http://<rcvisard>/api/v1/nodes/rc
_
stereomatching/parameters
Its median parameter could be set to 3 using
curl -X PUT --header 'Content-Type: application/json' -d '{ "value": 3 }' http://<rcvisard>/
˓→api/v1/nodes/rc
_
stereomatching/parameters/median
Note: Run-time parameters are specific to individual nodes and are documented in the respective soft-
ware component (Section 6).
Note: Most of the parameters that nodes offer via the REST-API can be explored and tested via the
rc_visard’s user-friendly Web GUI (Section 4.5).
Note: Some parameters exposed via the rc_visard’s REST-API are also available from the GigE Vision
2.0/GenICam image interface (Section 8.1). Please note that setting those parameters via the REST-API
is prohibited if a GenICam client is connected.
In addition, each node that offers run-time parameters also features services to save, i.e., persist, the current
parameter setting, or to restore the default values for all of its parameters.
Services: Some nodes also offer services that can be called via REST-API, e.g., to save and restore parameters as
discussed above, or to start and stop nodes. As an example, the services of pose estimation (see Stereo INS,
Section 6.5), could be listed using
curl -X GET http://<rcvisard>/api/v1/nodes/rc
_
stereo
_
ins/services
A node’s service is called by issuing a PUT request for the respective resource and providing the service-
specific arguments (see the "args" field of the Service data model, Section 8.2.3). As an example, egomo-
tion estimation can be switched on by:
curl -X PUT --header 'Content-Type: application/json' -d '{ "args": {} }' http://<rcvisard>
˓→/api/v1/nodes/rc
_
dynamics/services/start
Note: The services and corresponding argument data models are specific to individual nodes and are
documented in the respective software component (Section 6).
The following list includes all REST-API requests regarding the node’s status, parameters, and services calls:
GET /nodes
Get list of all available nodes.
Template request
GET /api/v1/nodes HTTP/1.1
Host: <rcvisard>
Sample response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"name": "rc
_
stereocalib",
"parameters": [
"grid
_
width",
"grid
_
height",
(continues on next page)
8.2. REST-API interface 130