Roboception rc visard Bedienungsanleitung Seite 170

Anfragetyp
GET
PUT
DELETE
POST
Je nach der Art der Anfrage und Datentyp können die Argumente für HTTP-Anfragen als Teil des Pfads (URI)
zur Ressource, als Abfrage-Zeichenfolge, als Formulardaten oder im Body der Anfrage übertragen werden. Die
folgenden Beispiele nutzen das Kommandozeilenprogramm curl, das für verschiedene Betriebssysteme verfügbar
ist (siehe https://curl.haxx).se.
• Abruf des aktuellen Status eines Moduls, wobei sein Name im Pfad (URI) verschlüsselt ist
'http://<host>/api/v1/nodes/rc _ stereomatching'
curl -X GET
• Abruf einiger Parameterwerte eines Moduls über eine Abfragezeichenfolge
'http://<host>/api/v1/nodes/rc _ stereomatching/parameters?name=minconf&
curl -X GET
name=maxdepth'
• Konfiguration eines neuen Datenstroms, wobei die Zielparameter als Formulardaten übertragen werden
curl -X PUT --header
1.14%3A30000' 'http://<host>/api/v1/datastreams/pose'
• Setzen eines Modulparameters als JSON-formatierter Text im Body der Anfrage
curl -X PUT --header
1}]' 'http://<host>/api/v1/nodes/rc _ stereomatching/parameters'
Zur Beantwortung solcher Anfragen greift die Programmierschnittstelle des rc_visard auf übliche Rückgabecodes
zurück:
Statuscode
200 OK
400 Bad Request
404 Not Found
403 Forbidden
429 Too many requests
8.2. REST-API-Schnittstelle
Beschreibung
Zugriff auf eine oder mehrere Res-
sourcen und Rückgabe des Ergeb-
nisses im JSON-Format
Änderung einer Ressource und
Rückgabe der modifizierten Res-
source im JSON-Format
Löschen einer Ressource
Upload einer Datei (z.B. einer Li-
zenz oder eines Firmware-Images)
'Content-Type: application/x-www-form-urlencoded'
'Content-Type: application/json'
Beschreibung
Die Anfrage war erfolgreich. Die
Ressource wird im JSON-Format
zurückgegeben.
Ein für die API-Anfrage benötigtes
Attribut oder Argument fehlt oder
ist ungültig.
Auf eine Ressource konnte nicht
zugegriffen werden. Möglicherwei-
se kann die ID einer Ressource
nicht gefunden werden.
Der Zugriff ist (vorübergehend)
verboten. Möglicherweise sind ei-
nige Parameter gesperrt, während
eine GigE Vision-Anwendung ver-
bunden ist.
Die Übertragungsrate ist aufgrund
einer zu hohen Anfragefrequenz be-
grenzt.
-d 'destination=10.0.
-d '[{"name": "mindepth", "value": 0.
167