Obseron REST API - Commands

Commands

General

• POST method
• JSON content
• Commands are “simple buttons”.  A command executes an single internal command and gives an response
• Executing the command might take some time, so response might not be instant.
• Return values
  • HTTP 500 InternalServerError: Command failed/timed out
  • HTTP 400 BadRequest: Command is invalid
  • HTTP 200 OK: Command completed successfully

Command structure:

{
    "target": identifier for target, for example id of the camera (string)
    "timeout": timeout in seconds (integer)
    "command": command (string)
}

Camera commands

Endpoint: https://server:port/api/camera_commands

Supported actions: POST

• "connect" (suggested timeout: >=2 seconds)
• "disconnect"

Permissions:

POST:   configureCameras

POST Request content to connect a camera:

POST https://server:port/api/camera_commands
{
    "target: "3a817447-56b0-4a35-9c82-354621ba25fd",
    "command": "connect",
    "timeout: 2
}

POST Response:

HTTP 200 OK

POST Request content to disconnect a camera:

POST https://server:port/api/camera_commands
{
    "target: "3a817447-56b0-4a35-9c82-354621ba25fd",
    "command": "disconnect",
    "timeout: 2
}

POST Response:

HTTP 200 OK