PhysicalDeduplicationRetainedDto

Endpoints · All schemas

Field	Required	Description
assetId	Yes	Asset that keeps the original file
canView	Yes	Whether the requesting administrator may view this asset and its thumbnail
checksum	Yes	Hex-encoded SHA-1 checksum of the original file
duration	Yes	Video length in milliseconds, when known
fileAvailable	Yes	Whether the retained original file is on disk now, checked on every read (UT-24)
height	Yes	Height in pixels, when known
hiddenCopies	Yes	Copies this retained original would share that are Locked media of another account; counted, never named ()
originalFileName	Yes	string
originalPath	Yes	Path of the retained original file
ownerId	Yes	Owner of the retained asset (the retained account)
ownerName	Yes	Display name of the retained account
referencesAfter	Yes	Assets that would reference this original after the plan is applied
referencesBefore	Yes	Assets that reference this original before the plan is applied (including the retained asset)
sizeInBytes	Yes	integer
type	Yes	See definition below
width	Yes	Width in pixels, when known

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AssetTypeEnum

{
  "properties": {
    "assetId": {
      "description": "Asset that keeps the original file",
      "type": "string"
    },
    "canView": {
      "description": "Whether the requesting administrator may view this asset and its thumbnail",
      "type": "boolean"
    },
    "checksum": {
      "description": "Hex-encoded SHA-1 checksum of the original file",
      "type": "string"
    },
    "duration": {
      "description": "Video length in milliseconds, when known",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "fileAvailable": {
      "description": "Whether the retained original file is on disk now, checked on every read (UT-24)",
      "type": "boolean"
    },
    "height": {
      "description": "Height in pixels, when known",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "hiddenCopies": {
      "description": "Copies this retained original would share that are Locked media of another account; counted, never named ()",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "originalFileName": {
      "type": "string"
    },
    "originalPath": {
      "description": "Path of the retained original file",
      "type": "string"
    },
    "ownerId": {
      "description": "Owner of the retained asset (the retained account)",
      "type": "string"
    },
    "ownerName": {
      "description": "Display name of the retained account",
      "type": "string"
    },
    "referencesAfter": {
      "description": "Assets that would reference this original after the plan is applied",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "referencesBefore": {
      "description": "Assets that reference this original before the plan is applied (including the retained asset)",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "sizeInBytes": {
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "type": {
      "$ref": "#/components/schemas/AssetTypeEnum"
    },
    "width": {
      "description": "Width in pixels, when known",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    }
  },
  "required": [
    "assetId",
    "canView",
    "checksum",
    "duration",
    "fileAvailable",
    "height",
    "hiddenCopies",
    "originalFileName",
    "originalPath",
    "ownerId",
    "ownerName",
    "referencesAfter",
    "referencesBefore",
    "sizeInBytes",
    "type",
    "width"
  ],
  "type": "object"
}