Media export

Requesting video exports and collecting the results.

Every path on this page is plugin-scoped: {pluginInstalledId} is the id of the module instance you are talking to, from Plugins. A deployment can run more than one instance of the same module, and the id is what tells them apart.

5 endpoints. Every one needs Authorization: Bearer <access token>; see Getting Started.

Permissions

The server authorises every call against the signed-in user's permission keys — the same keys the client is held to. For this module they are the ExportServer*, Video Manual Export and Video Local Export key families. See the Permission Keys reference.

Exports

Method	Path	What it does
GET	media-export/plugins/{pluginInstalledId}/exports	Returns a list of exports created by this user.
POST	media-export/plugins/{pluginInstalledId}/exports	Media export new
DELETE	media-export/plugins/{pluginInstalledId}/exports/{mediaExportID}	Media export remove
POST	media-export/plugins/{pluginInstalledId}/exports/{mediaExportId}/retry	Media export retry
GET	media-export/plugins/{pluginInstalledId}/exports/{mediaExportID}/status	Will return the current status of the media export ID

POST media-export/plugins/{pluginInstalledId}/exports

Media export new.

Parameter	In	Required	Type
mediaStartTime	query	no	date-time
mediaEndTime	query	no	date-time
postbackUri	query	no	string

Payload

Request body

{
  "deviceItem": {
    "deviceAttributes": [
      {
        "deviceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
        "settingKey": "string",
        "boolValue": true,
        "doubleValue": 125.5,
        "stringValue": "string"
      }
    ],
    "isNew": true,
    "capabilities": [
      42
    ],
    "pluginAssociations": [
      {
        "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
        "pluginType": 42,
        "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
        "properties": 42,
        "orderIndex": 42
      }
    ],
    "pluginEntityItem": {
      "pluginInstalledID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "pluginType": 42,
      "remoteID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "properties": 42,
      "orderIndex": 42
    },
    "deviceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "dateTimeCreated": "2026-10-02T21:14:05Z",
    "dateTimeUpdated": "2026-10-02T21:14:05Z",
    "deviceType": "string",
    "isDeleted": true,
    "isDisabled": true,
    "name": "Example",
    "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "timeZone": "string"
  },
  "metaDataContainerItems": [
    {
      "title": "string",
      "metaDataItems": [
        {}
      ]
    }
  ]
}

Response

{
  "mediaExportID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "created": "2026-10-02T21:14:05Z",
  "lastUpdated": "2026-10-02T21:14:05Z",
  "statusMessage": "string",
  "currentStatus": 42,
  "title": "string",
  "startTime": "2026-10-02T21:14:05Z",
  "endTime": "2026-10-02T21:14:05Z",
  "exportableFiles": [
    {
      "title": "string",
      "fileSize": 42,
      "fileName": "Example",
      "desiredFileName": "Example"
    }
  ],
  "exportState": "string",
  "exportPercentComplete": 42
}

POST media-export/plugins/{pluginInstalledId}/exports/{mediaExportId}/retry

Media export retry.

Parameter	In	Required	Type
mediaExportId	path	yes	uuid

Payload