The REST APIs provides programmatic access to read and write BACnet data, configure your ECLYPSE system, manage the users and more. The REST API identifies ECLYPSE applications and users using BASIC authentication; responses are available in JSON and Xml.
Query parameters defines a number of system query options that allow refining the request.
Below, there is all the system query options implemented for the ECLYPSE Rest API.
All the resources can be browse from a browser.
POST /system/backup/targets/{target}/files/{fileName}/restore
GET /system/cloud/providers/atrius/services/asset/logs/document
POST /system/cloud/providers/atrius/services/asset/logs/start
POST /system/cloud/providers/atrius/services/asset/logs/stop
POST /system/cloud/providers/atrius/services/spaces/send-topology
POST /system/open-adr/server/certificates/{certificate}/document
POST /system/web-server/protocols/https/certificate/document
GET /info/extension-management/extensions/{uniqueIdExtension}
GET /protocols/bacnet/communication/network/ip-ports/{id}/bbmd-list
POST /protocols/bacnet/communication/network/ip-ports/{id}/bbmd-list
GET /protocols/bacnet/communication/network/ip-ports/{id}/bbmd-list/{bbmdId}
PUT /protocols/bacnet/communication/network/ip-ports/{id}/bbmd-list/{bbmdId}
DELETE /protocols/bacnet/communication/network/ip-ports/{id}/bbmd-list/{bbmdId}
GET /protocols/bacnet/communication/network/ip-ports/{id}/foreign-devices
GET /protocols/bacnet/communication/network/ip-ports/{id}/foreign-devices/{foreignDeviceId}
POST /protocols/bacnet/communication/network/mstp-ports/{id}
GET /protocols/bacnet/communication/network/router-entries/{networkNumber}
GET /protocols/bacnet/local/objects/calendar/{objectInstance}/properties/date-list
POST /protocols/bacnet/local/objects/calendar/{objectInstance}/properties/date-list
GET /protocols/bacnet/local/objects/{objectType}/{objectInstance}
GET /protocols/bacnet/local/objects/{objectType}/{objectInstance}/properties
GET /protocols/bacnet/local/objects/{objectType}/{objectInstance}/properties/{propertyName}
POST /protocols/bacnet/local/objects/{objectType}/{objectInstance}/properties/{propertyName}
GET /protocols/bacnet/local/objects/{objectType}/{objectInstance}/trend
GET /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/exception-schedule
POST /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/exception-schedule
GET /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/weekly-schedule
POST /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/weekly-schedule
POST /protocols/bacnet/local/objects/write-property-multiple
GET /protocols/bacnet/remote/devices/{remoteDeviceId}/objects
GET /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/{objectType}
GET /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/{objectType}/{objectInstance}
POST /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/read-property-multiple
POST /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/start-discovery
POST /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/write-property-multiple
GET /protocols/m-bus/devices/{mbusDeviceId}/points/{mbusPointId}
POST /protocols/m-bus/devices/{mbusDeviceId}/points/start-discovery
GET /protocols/nlight/channels/{channelId}/object-types/{channelResourceType}
GET /protocols/nlight/channels/{channelId}/object-types/{channelResourceType}/{objectInstance}
GET /protocols/nlight/devices/{nlightDeviceId}/object-types/{resourceType}
GET /protocols/nlight/devices/{nlightDeviceId}/object-types/{resourceType}/{objectInstance}
GET /protocols/nlight/profiles/{resourceNumber}/object-types
GET /protocols/nlight/profiles/{resourceNumber}/object-types/{resourceType}
GET /protocols/nlight/profiles/{resourceNumber}/object-types/{resourceType}/{objectInstance}
GET /protocols/ips-luminaire/command-history/{commandHistoryID}
GET /protocols/ips-luminaire/luminaires/{luminairePositionID}
POST /protocols/ips-luminaire/luminaires/{luminairePositionID}/reset
GET /protocols/ips-luminaire/uncommissioned-luminaires/{beaconUUID}
POST /protocols/ips-luminaire/uncommissioned-luminaires/{beaconUUID}/reset
POST /protocols/ips-luminaire/uncommissioned-luminaires/clear
POST /engine/resources/ble-room-devices/write-devices-multiple