MICRO-EPSILON colorSENSOR CFO Series, Instruction Manual

Page: 97 / 124

Page 97
Anhang | API Communication with Controller (Version 0.7.1)
colorSENSOR CFO
A 3.5 API
A 3.5.1 General
- Collections (arrays and lists) can be queried with
GET
.
ƒ Filtering operations using defined attributes as query parameters are possible.
- Optional: Some collections allow
POST
requests to create additional collection elements.
ƒ If required, attributes for the new collection entries deviating from their standard values can be overwrit-
ten using query parameters.
ƒ Errors when creating objects are signaled with the HTTP status code 400 (Bad Request).
- Optional: Some collections support deletion of elements.
ƒ The collection is emptied when a filter is not specified.
ƒ
Filter rules correspond to those of
GET
Requests for this collection.
ƒ A
DELETE
request is always successful, regardless of the number of objects actually deleted.
- Individual entries can be queried via
GET
.
ƒ Typically the path corresponds to the following scheme: /COLLECTION_PATH/UNIQUE_ID.
ƒ
Requests for IDs not present are acknowledged by the HTTP status code 404 (Not Found).
ƒ Filtering operations using defined attributes as query parameters are possible.
- Optional: Some types of entries can be modified with
PUT
requests.
ƒ The data set to be changed is transferred as a JSON data set in the body of the request.
ƒ
Attributes missing in the data set remain unchanged.
ƒ The values for read-only attributes must not differ from the previous state - otherwise an HTTP status
code 400 (Bad Request) is returned.
ƒ As a matter of principle it is not possible to change the unique ID for an entry (typically the key uuid).
ƒ
A successful request is acknowledged with the new entry state in the body of the response.
- Optional: Some types of entries can be deleted with
DELETE
requests.
- All properties of
GET
requests for collections also apply for their
POST
requests.
- All properties of
GET
requests for entries also apply for their
PUT
requests.