Event Webservice

Get list of saved clips in organization, with current progress

Get list of saved clips in organization, with current progress

post/api/event/getClipsWithProgress

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getClipsWithProgress
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

deviceUuidFiltersstring[] nullable

Device uuids to filter clips by.

excludeAlertMonitoringClipsboolean nullable

Filter to exclude clips created for alarm monitoring verification.

filterByPrivateboolean nullable

Filter to only include private clips in the result.

locationUuidFiltersstring[] nullable

Location uuids to filter clips by.

pageSizeinteger nullable required

Page size

pageTokenstring nullable

Page token received from the previous search request.

searchFilterstring nullable

Search filter for clips

sortFieldstring nullable

Field to sort clips by

sortOrderstring nullable

Sort order (asc or desc)

timestampFilterFieldstring nullable

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

timestampMsAfterinteger nullable

Timestamp to find clips after this time.

timestampMsBeforeinteger nullable

Timestamp to find clips before this time

Example request

{
  "deviceUuidFilters": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "locationUuidFilters": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "pageToken": "next_page_token_123",
  "searchFilter": "motion detected",
  "sortField": "timestamp",
  "sortOrder": "desc",
  "timestampMsAfter": 1640995200000,
  "timestampMsBefore": 1641081600000
}

Response

OK

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
pageTokenstring nullable

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

warningMsgstring nullable

Example response

{
  "savedClips": [
    {
      "accessSettings": {
        "allowedRoles": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "allowedUsers": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "currentOperation": "Processing video",
      "devicePresentationOrder": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "deviceUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "lastUpdatedSec": 1640995200,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "percentComplete": 75,
      "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.