Skip to main content
POST
/
api
/
video
/
getTimelapseClips
Get timelapse clips
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/getTimelapseClips \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "timelapseClips": [
    {
      "clipCreationTime": 123,
      "clipDuration": 123,
      "clipFormat": "MPEG",
      "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "description": "<string>",
      "drawCameraDetails": true,
      "drawTimestamp": true,
      "drawWatermark": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "passwordDigest": "<string>",
      "shared": true,
      "skipNights": true,
      "skipNonBusinessHours": true,
      "skipWeekends": true,
      "sources": [
        {
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
        }
      ],
      "status": {
        "percentComplete": 123,
        "state": "INITIATED"
      },
      "title": "<string>",
      "videoStartTime": 123,
      "videoStopTime": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting all timelapse clips for the organization.

Response

200 - application/json

OK

Response object containing all timelapse clips for the organization.

error
boolean | null
errorMsg
string | null
timelapseClips
object[] | null

List of timelapse clips for the organization

warningMsg
string | null