Get custom footage seekpoints V2

Get activity seekpoints for specified camera

POST /api/camera/getCustomFootageSeekpointsV2

Get custom footage seekpoints V2

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getCustomFootageSeekpointsV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "customDescription": "Motion detected in camera view",
  "customDisplayName": "motion_event",
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "duration": 3600,
  "locationUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "startTime": 1640995200
}
'

200

{
  "customFootageSeekPoints": [
    {
      "compositComponentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "customDescription": "<string>",
      "customDisplayName": "<string>",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request to retrieve custom footage seek points V2 for cameras within a time range.

customDescription · string | null

Filters which custom footage seek point to search for by description

Example:

"Motion detected in camera view"

customDisplayName · string | null

Filters which custom footage seek point to search for by name

Example:

"motion_event"

deviceUuids · (string<DeviceFacetUuid> | null)[] | null

List of device UUIDs to filter the search

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

duration · integer<int64> | null

How far from the start timestamp to search in seconds

Example:

3600

locationUuids · (string<RUUID> | null)[] | null

List of location UUIDs to filter the search

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

startTime · integer<int64> | null

Starting timestamp of the search in UNIX seconds

Example:

1640995200

Response

200 - application/json

OK

Response containing custom footage seek points V2 for cameras.

customFootageSeekPoints · object[] | null

List of custom footage seek points V2

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null