A 3.5 Api - MICRO-EPSILON colorSENSOR CFO200 Betriebsanleitung

Anhang | API-Kommunikation mit Controller (Version 0.7.1)
A 3.5
A 3.5.1
- Collections (Arrays bzw. Listen) können via GET abgefragt werden.
- Optional: Einige Collections erlauben POST Anfragen für die Erzeugung zusätzlicher Elemente der Collec-
- Optional: Einige Collections unterstützen die Löschung von Elementen.
- Einzelne Einträge können via GET abgefragt werden.
- Optional: Einige Eintragstypen können durch PUT Anfragen geändert werden.
- Optional: Einige Eintragstypen können durch DELETE Requests gelöscht werden.
- Alle Eigenschaften von GET Requests für Collections gelten auch für deren POST Requests.
- Alle Eigenschaften von GET Requests für Einträge gelten auch für deren PUT Requests.
colorSENSOR CFO
API
Allgemeines
ƒ Eventuell sind Filterungen anhand definierter Attribute als Query-Parameter möglich.
tion.
ƒ Bei Bedarf können Attribute der neuen Collection-Einträge durch Query-Paramter abweichend von ihren
Standard-Werten überschrieben werden.
ƒ Fehler bei der Objekt-Erzeugung werden mit einem HTTP-Status-Code 400 (Bad Request) signalisiert.
ƒ Ohne Angabe eines Filters wird die Collection geleert.
ƒ Filter-Regeln entsprechen denen des GET Requests auf diese Collection.
ƒ Unabhängig von der Anzahl der tatsächlich gelöschten Objekte endet ein DELETE Request immer
erfolgreich.
ƒ Typischerweise entspricht der Pfad folgendem Schema: /COLLECTION_PATH/UNIQUE_ID.
ƒ Anfragen nach nicht vorhandenen IDs werden durch HTTP-Status-Code 404 (Not Found) quittiert.
ƒ Eventuell sind Filterungen anhand definierter Attribute als Query-Parameter möglich.
ƒ Der zu ändernde Datensatz wird als JSON-Datensatz im Body des Requests übertragen.
ƒ Im JSON-Datensatz fehlende Attribute bleiben unverändert.
ƒ Nur-lese-Attribute dürfen keinen vom bisherigen Zustand abweichenden Wert haben - andernfalls wird
ein HTTP-Status-Code 400 (Bad Request) zurückgeliefert.
ƒ Die eindeutige ID des Eintrags (typischerweise der Schlüssel uuid) ist grundsätzlich nicht veränderlich.
ƒ Eine erfolgreiche Anfrage wird mit dem neuen Zustand des Eintrags im Body der Response quittiert.
Seite 97