Rio 3.0 API Changes

Versions

Changes from RioBroker API 2.0.0 to RioBroker API 3.0.0.

What's New

  1. GET/api/messages Lists the messages in RioBroker.
  2. PATCH/api/messages Updates all the messages.
  3. GET/api/messages/{messageId} Returns details about a message.
  4. PATCH/api/messages/{messageId} Updates a message.
  5. DELETE/api/jobs/ Delete all jobs that are no longer active.
  6. POST/api/batch Performs multiple operations such as delete object in one API call.
  7. POST/api/devices/{deviceType}/{deviceName}/{deviceOperation} Perform an operation on a device.
  8. GET/api/tokens/current Returns details about the currently used token
  9. GET/api/keys/{apiKeyId} Returns details about the API Key
  10. DELETE/api/keys/{apiKeyId} Deletes and deactivates an API Key.
  11. HEAD/api/keys/{apiKeyId} Determines if an API Key exists.
  12. GET/api/keys Lists API keys that a user has created.
  13. POST/api/keys Creates a new API Key.
  14. GET/api/tokens/certificate Returns a JWT Key Set containing the Elliptic Curve public key components for verifying JWT Signatures.
  15. POST/api/devices/{deviceType} Create a device.
  16. DELETE/api/jobs/{jobId} Deletes a job that is no longer active.

What's Deprecated

  1. GET /api/brokers/{brokerName}/relationships Lists all the relationships for this broker.
  2. GET /api/auth/certificate Returns the public key as Elliptic Curve components for asymmetrically verifying the System Token's Signature.
  3. GET /api/devices/spectra Lists Spectra devices.
  4. POST /api/devices/spectra Creates a new Spectra device.
  5. GET /api/devices/spectra/{deviceName} Get Spectra device connection information.
  6. DELETE /api/devices/spectra/{deviceName} Deletes a Spectra device.
  7. HEAD /api/devices/spectra/{deviceName} Detects if a Spectra device exists.
  8. GET /api/brokers/{brokerName}/relationships/{relationshipName} Lists all of the objects in the specified relationship in a broker.
  9. HEAD /api/brokers/{brokerName}/relationships/{relationshipName} Returns a 200 if the relationship exists for this broker, and a 404 otherwise. There is no payload associated with this request.
  10. POST /api/devices/{deviceType}/{deviceName} Create a device.