Obseron REST API - General information

General

• Data format is JSON
• API root is https://address:port/api
• Endpoints are using https://address:port/api/<resources>/<resource> syntax
• Resource corresponds the id field in data
• Requests receive HTTP OK or HTTP Bad Request
• PATCH command: none of the fields is mandatory, changes only supplied fields.
• POST command: every field is mandatory (null value is sometimes allowed)
• PATCH and DELETE actions should be sent to the resource (example: https://address:port/api/cameras/c6d6ef81-2dfe-411a-8bee-e16137b1b135)
• Resources usually have “id” and “name” fields
  • id - unique identifier for the resource (uuidv4)
  • name - user facing name, not unique
• Uses HTTP basic authentication, requires allowRemote permission for user
• SSL/TLS is supported