Event

Get list of expiring saved clips in organization

Get list of expiring saved clips in organization.

POST/api/event/getExpiringClipsForOrg

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for retrieving clips with progress information and filtering options.

deviceUuidFiltersstring<RUUID>[] | nullbody

Device uuids to filter clips by.

excludeAlertMonitoringClipsboolean | nullbodydefault: false

Filter to exclude clips created for alarm monitoring verification.

filterByPrivateboolean | nullbodydefault: false

Filter to only include private clips in the result.

locationUuidFiltersstring<RUUID>[] | nullbody

Location uuids to filter clips by.

pageSizeinteger<int32> | nullbodyrequireddefault: 100

Page size

Range: 1 to 200

pageTokenstring | nullbody

Page token received from the previous search request.

Example: "next_page_token_123"

searchFilterstring | nullbody

Search filter for clips

Example: "motion detected"

sortFieldstring | nullbody

Field to sort clips by

Example: "timestamp"

sortOrderstring | nullbody

Sort order (asc or desc)

Example: "desc"

timestampFilterFieldstring | nullbody

Timestamp to filter clips by (either clip creation date or clip footage date).

timestampMsAfterinteger<int64> | nullbody

Timestamp to find clips after this time.

Example: 1640995200000

timestampMsBeforeinteger<int64> | nullbody

Timestamp to find clips before this time

Example: 1641081600000

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/event/getExpiringClipsForOrg' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuidFilters": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "excludeAlertMonitoringClips": false,
    "filterByPrivate": false,
    "locationUuidFilters": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "pageSize": 100,
    "pageToken": "next_page_token_123",
    "searchFilter": "motion detected",
    "sortField": "timestamp",
    "sortOrder": "desc",
    "timestampFilterField": "<string>",
    "timestampMsAfter": 1640995200000,
    "timestampMsBefore": 1641081600000
  }'

import requests

url = "https://api2.rhombussystems.com/api/event/getExpiringClipsForOrg"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuidFilters": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "excludeAlertMonitoringClips": False,
    "filterByPrivate": False,
    "locationUuidFilters": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "pageSize": 100,
    "pageToken": "next_page_token_123",
    "searchFilter": "motion detected",
    "sortField": "timestamp",
    "sortOrder": "desc",
    "timestampFilterField": "<string>",
    "timestampMsAfter": 1640995200000,
    "timestampMsBefore": 1641081600000
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/event/getExpiringClipsForOrg', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuidFilters": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "excludeAlertMonitoringClips": false,
    "filterByPrivate": false,
    "locationUuidFilters": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "pageSize": 100,
    "pageToken": "next_page_token_123",
    "searchFilter": "motion detected",
    "sortField": "timestamp",
    "sortOrder": "desc",
    "timestampFilterField": "<string>",
    "timestampMsAfter": 1640995200000,
    "timestampMsBefore": 1641081600000
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "deviceUuidFilters": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "excludeAlertMonitoringClips": false,
              "filterByPrivate": false,
              "locationUuidFilters": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "pageSize": 100,
              "pageToken": "next_page_token_123",
              "searchFilter": "motion detected",
              "sortField": "timestamp",
              "sortOrder": "desc",
              "timestampFilterField": "<string>",
              "timestampMsAfter": 1640995200000,
              "timestampMsBefore": 1641081600000
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/event/getExpiringClipsForOrg"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "pageToken": "<string>",
  "savedClips": [
    {
      "accessSettings": {
        "allowedRoles": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "allowedUsers": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "visibility": "PRIVATE"
      },
      "alterMap": {
        "<key>": [
          {}
        ]
      },
      "analyzed": true,
      "byteCount": 0,
      "clipLocation": {
        "region": "<string>"
      },
      "clipLocationV2": "<string>",
      "consoleDelete": true,
      "createdAtMs": 0,
      "currentOperation": "Processing video",
      "description": "<string>",
      "deviceIntervalMap": {
        "<key>": [
          {}
        ]
      },
      "devicePresentationOrder": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "deviceUuidMap": {
        "<key>": {
          "region": "<string>"
        }
      },
      "deviceUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "durationSec": 0,
      "externalTransactionId": "<string>",
      "fisheyeHardware": "RASPBERRY_PI_3",
      "fisheyeMap": {
        "<key>": [
          {}
        ]
      },
      "integrationUploadList": [
        "AVIGILON_ALTA"
      ],
      "isMonitoringClip": true,
      "isVendorClip": true,
      "lastUpdatedSec": 1640995200,
      "mountingDirection": "DOWN",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "percentComplete": 75,
      "placeholder": true,
      "sendToSharedStorage": true,
      "sha256Hex": "<string>",
      "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "status": "INITIATING",
      "thumbnailLocation": {
        "region": "<string>"
      },
      "thumbnailLocationV2": "<string>",
      "timestampMs": 0,
      "title": "<string>",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "videoResolution": {
        "height": 0,
        "width": 0
      }
    }
  ]
}

Response

200 OK

application/json · object

Response object containing clips with progress information.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

pageTokenstring | null

Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.

savedClipsobject[] | null

List of saved clips with progress information

Show child attributes

accessSettingsobject

Visibility setting for the clip

Show child attributes

allowedRolesstring<RUUID>[] | null

allowedUsersstring<RUUID>[] | null

visibilityenum<string>

Use accessSettings instead

Available options: PRIVATE, ROLE_RESTRICTED, ORG_WIDE

alterMapobject | null

Show child attributes

cropobject

Show child attributes

heightinteger<int32> | null

widthinteger<int32> | null

xinteger<int32> | null

yinteger<int32> | null

dewarpobject

Show child attributes

aspectRatioobject

Show child attributes

heightinteger<int32> | null

widthinteger<int32> | null

pitchDegreesnumber<float> | null

rollDegreesnumber<float> | null

verticalFieldOfViewDegreesinteger<int32> | null

yawDegreesnumber<float> | null

analyzedboolean | null

byteCountinteger<int64> | null

clipLocationobject

Show child attributes

regionstring | null

clipLocationV2string | null

consoleDeleteboolean | null

createdAtMsinteger<int64> | null

currentOperationstring | null

Current operation being performed on the clip

Example: "Processing video"

descriptionstring | null

deviceIntervalMapobject | null

Show child attributes

endMsinteger<int64> | null

startMsinteger<int64> | null

devicePresentationOrderstring<DeviceFacetUuid>[] | null

deviceUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

deviceUuidMapobject | null

Show child attributes

regionstring | null

deviceUuidsstring<DeviceFacetUuid>[] | null

durationSecinteger<int32> | null

externalTransactionIdstring | null

fisheyeHardwareenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

fisheyeMapobject | null

Show child attributes

aspectRatioobject

Show child attributes

heightinteger<int32> | null

widthinteger<int32> | null

pitchDegreesnumber<float> | null

rollDegreesnumber<float> | null

verticalFieldOfViewDegreesinteger<int32> | null

yawDegreesnumber<float> | null

integrationUploadListenum<string>[] | null

isMonitoringClipboolean | null

isVendorClipboolean | null

lastUpdatedSecinteger<int64> | null

Last update timestamp in seconds

Example: 1640995200

mountingDirectionenum<string>

Available options: DOWN, UP, SIDEWAYS, UNKNOWN

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

percentCompleteinteger<int32> | null

Percentage of completion for the current operation

Example: 75

placeholderboolean | null

sendToSharedStorageboolean | null

sha256Hexstring | null

sourceAlertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

statusenum<string>

Available options: INITIATING, UPLOADING, RENDERING, FAILED, COMPLETE, OFFLINE, DELETED, UNKNOWN

thumbnailLocationobject

Show child attributes

regionstring | null

thumbnailLocationV2string | null

timestampMsinteger<int64> | null

titlestring | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

videoResolutionobject

Show child attributes

heightinteger<int32> | null

widthinteger<int32> | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.