v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Downloads

Gets details of a download based on its ID.

get/downloads/{id}

Query parameters

includestring[]

The fields you want included in the response. If not specified, the response will include a default set of fields specific to this method. For development purposes, you can use the special value * to return all fields; however, you will achieve better performance by selecting only the fields you need.

Response

OK

idstring uuid required

The ID of the download.

directorystring

Name of the parent directory.

mimeTypestring

The media content type.

namestring

Name of the item.

expireTimestampstring date-time
status'available' | 'expired'

Expiration status of the download. Possible values are "available" or "expired".

Example response

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "directory": "/Bundles/North Door",
  "mimeType": "video/mp4",
  "name": "Video North Door 2022-08-03 23-04-50.mp4",
  "expireTimestamp": "2021-04-22T00:00:00.000+00:00",
  "status": "available"
}