Users Manual

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 157
{
"name": "minconf",
"min": 0,
"default": 0,
"max": 1,
"value": 0,
"type": "float64",
"description": "Minimum confidence"
}
Note: The actual behavior, allowed requests, and specific return codes depend heavily on the specific resource,
context, and action. Please refer to the rc_visard’s available resources (Section 8.2.2) and to each software
component’s (Section 6) parameters and services.
8.2.2 Available resources and requests
The available REST-API resources are structured into the following parts:
• /nodes: Access the rc_visard’s software components (Section 6) with their run-time status, parameters,
and offered services.
• /datastreams: Access and manage data streams of the rc_visard’s The rc_dynamics interface (Section
8.3).
• /logs: Access the log files on the rc_visard.
• /system: Access the system state and manage licenses as well as firmware updates.
Nodes, parameters, and services
Nodes represent the rc_visard’s software components (Section 6), each bundling a certain algorithmic functional-
ity. All available REST-API nodes can be listed with their service calls and parameters using
curl -X GET http://<rcvisard>/api/v1/nodes
Information about a specific node (e.g., rc
_
stereocamera) can be retrieved using
curl -X GET http://<rcvisard>/api/v1/nodes/rc
_
stereocamera
Status: During run-time, each node offers information about its current status. This includes not only the current
processing status of the component (e.g., running or stale), but most nodes also offer run-time statistics
or read-only parameters, so-called status values. As an example, the rc
_
stereocamera values can be
retrieved using
curl -X GET http://<rcvisard>/api/v1/nodes/rc
_
stereocamera/status
Note: The returned status values are specific to individual nodes and are documented in the respective
software component (Section 6).
Note: The status values are only reported when the respective node is in the running state.
Parameters: Most nodes expose parameters via the rc_visard’s REST-API to allow their run-time behaviors to
be changed according to application context or requirements. The REST-API permits to read and write a
parameter’s value, but also provides further information such as minimum, maximum, and default values.
8.2. REST-API interface 129