Video

Get spliced clips in progress

Get all spliced clips in progress

POST/api/video/getSplicedClipsInProgress

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 getting all spliced clips in progress.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/video/getSplicedClipsInProgress' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/video/getSplicedClipsInProgress"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

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

const response = await fetch('https://api2.rhombussystems.com/api/video/getSplicedClipsInProgress', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
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 = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/video/getSplicedClipsInProgress"))
            .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>",
  "splicedClips": [
    {
      "accessSettings": {
        "allowedRoles": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "allowedUsers": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "visibility": "PRIVATE"
      },
      "analyzeClip": true,
      "clipTargetLocation": {
        "region": "<string>"
      },
      "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "completedSubClipCount": 0,
      "consoleDelete": true,
      "deleted": false,
      "description": "<string>",
      "deviceIntervalMap": {
        "<key>": [
          {}
        ]
      },
      "deviceMap": {
        "<key>": {
          "region": "<string>",
          "segmentsUploaded": 0,
          "totalSegments": 0
        }
      },
      "devicePresentationOrder": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "deviceUuidMap": {
        "<key>": {
          "region": "<string>",
          "segmentsUploaded": 0,
          "totalSegments": 0
        }
      },
      "deviceUuidToAlteredViewMap": {
        "<key>": [
          {}
        ]
      },
      "deviceUuidToFisheyePresentationMap": {
        "<key>": [
          {}
        ]
      },
      "duration": 0,
      "expectedSubClipCount": 0,
      "integrationUploadList": [
        "AVIGILON_ALTA"
      ],
      "isPolicyEvent": true,
      "metadataBucketRegion": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "parentClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pendingConsumers": [
        "<string>"
      ],
      "policyEventPipeline": "DEFAULT",
      "saveClip": true,
      "saveFrame": true,
      "segmentsUploaded": 0,
      "sendToSharedStorage": true,
      "startTime": 0,
      "status": "INITIATING",
      "statusUpdatedAtMs": 0,
      "thumbnailRelativeSecond": 0,
      "timestampMs": 0,
      "title": "<string>",
      "totalSegments": 0,
      "transactionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Response

200 OK

application/json · object

Response object containing all spliced clips in progress.

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

splicedClipsobject[] | null

List of spliced clips currently in progress

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

analyzeClipboolean | null

clipTargetLocationobject

Show child attributes

regionstring | null

clipUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

completedSubClipCountinteger<int32> | null

consoleDeleteboolean | null

deletedboolean | null

descriptionstring | null

deviceIntervalMapobject | null

Show child attributes

endMsinteger<int64> | null

startMsinteger<int64> | null

deviceMapobject | null

Show child attributes

regionstring | null

segmentsUploadedinteger<int32> | null

totalSegmentsinteger<int32> | null

devicePresentationOrderstring<DeviceFacetUuid>[] | null

deviceUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

deviceUuidMapobject | null

Show child attributes

regionstring | null

segmentsUploadedinteger<int32> | null

totalSegmentsinteger<int32> | null

deviceUuidToAlteredViewMapobject | 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

deviceUuidToFisheyePresentationMapobject | 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

durationinteger<int32> | null

expectedSubClipCountinteger<int32> | null

integrationUploadListenum<string>[] | null

isPolicyEventboolean | null

metadataBucketRegionstring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

parentClipUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pendingConsumersstring[] | null

policyEventPipelineenum<string>

Available options: DEFAULT, POLICY_ALERT_PUBLISHER

saveClipboolean | null

saveFrameboolean | null

segmentsUploadedinteger<int32> | null

sendToSharedStorageboolean | null

startTimeinteger<int64> | null

statusenum<string>

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

statusUpdatedAtMsinteger<int64> | null

thumbnailRelativeSecondnumber<float> | null

timestampMsinteger<int64> | null

titlestring | null

totalSegmentsinteger<int32> | null

transactionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

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.