Ressourcen Und Anfragen - Roboception rc visard Montage- Und Betriebsanleitung

8.3. REST-API-Schnittstelle
Host-Name Netzwerkkon
(siehe
diese Adresse zu, kann er die Programmierschnittstelle während der Laufzeit mithilfe der
(Abschnitt 8.3.4) erkunden und testen.
Für die eigentlichen HTTP-Anfragen wird dem Einstiegspunkt der Programmierschnittstelle die aktu-
elle Version der Schnittstelle als Post x angehangen, d.h.
an die REST-API gesandt und von ihr empfangen werden, entsprechen dem JSON-Datenformat (JavaS-
cript Object Notation). Die Programmierschnittstelle ist so gestaltet, dass der Benutzer die in

Ressourcen und Anfragen

HTTP-Anforderungen anlegen, abrufen, ändern und löschen kann.
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 übertra-
gen 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'
• Kon guration 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ück-
gabecodes zurück:
Roboception GmbH
Handbuch: rc_visard
guration, Abschnitt 4.5). Greift der Benutzer über einen Webbrowser auf
(Abschnitt 8.3.2) aufgelisteten sogenannten Ressourcen über die folgenden
'Content-Type: application/x-www-form-urlencoded'
'Content-Type: application/json'
http://<host>/api/v1
Beschreibung
Zugriff auf eine oder mehrere
Ressourcen und Rückgabe des
Ergebnisses im JSON-Format
Änderung einer Ressource und
Rückgabe der modi zierten Res-
source im JSON-Format
Löschen einer Ressource
Upload einer Datei (z.B. einer
Lizenz oder eines Firmware-
Images)
-d '[{"name": "mindepth", "value": 0.
204
Swagger UI
. Alle Daten, die
Verfügbare
-d 'destination=10.0.
Rev: 21.01.1
Status: 30.01.2021