REST API Overview
Methods
The REST API is divided into several areas:
| URL | Description |
|---|---|
http://<hostname>/ping | Pinging the web service. Returns "OK" if service is available. |
http://<hostname>/nodes | Managing nodes in the node space, such as adding, removing and querying nodes, rules etc. |
http://<hostname>/nodes/node | Managing nodes |
http://<hostname>/nodes/relation | Managing binary relations |
http://<hostname>/nodes/group | Managing groups |
http://<hostname>/nodes/command | Commanding interface to execute commands directly |
http://<hostname>/nodes/data | Reading or writing data values to data nodes |
http://<hostname>/nodes/enum | Reading enumeration type information |
http://<hostname>/nodes/workflow | Managing workflows |
http://<hostname>/alarms/pool | Managing alarming (alarm and event access) |
http://<hostname>/entities | Managing entity collections, such as adding, querying, removing and updating entity collections. |
http://<hostname>/activities | Managing human activities |
http://<hostname>/history | Historical data access |
http://<hostname>/* | Custom Processing |
Return Codes
The API follows the standard return types:
| HTTP Status Code | Description |
|---|---|
| 100 | Good continue |
| 200 | Good done |
| 400 | Bad arguments, bad data, bad processing, other errors |
| 401 | Access denied |
| 410 | Data access point not active |
| 420 | Bad address or bad connection |
| 423 | Call locked |
| 500 | Fatal error, out of memory |
| 501 | Not supported or not implemented |