Skip to content

PhysicalDeduplicationCopyDto

Endpoints · All schemas

FieldRequiredDescription
assetIdYesDuplicate asset owned by a non-retained account
canViewYesWhether the requesting administrator may view this asset and its thumbnail
checksumYesHex-encoded SHA-1 checksum of the original file
checksumMatchYesWhether checksum and byte size match a retained original
decisionYesSee definition below
durationYesVideo length in milliseconds, when known
heightYesHeight in pixels, when known
originalFileNameYesstring
originalPathYesPath of the duplicate copy on disk
ownerIdYesstring
ownerNameYesDisplay name of the copy owner
reasonYesPresent when the decision is skip
retainedAssetIdYesRetained original this copy matches, if any
sizeInBytesYesinteger
typeYesSee definition below
widthYesWidth 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: PhysicalDeduplicationDecision, PhysicalDeduplicationSkipReason, AssetTypeEnum

{
  "properties": {
    "assetId": {
      "description": "Duplicate asset owned by a non-retained account",
      "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"
    },
    "checksumMatch": {
      "description": "Whether checksum and byte size match a retained original",
      "type": "boolean"
    },
    "decision": {
      "$ref": "#/components/schemas/PhysicalDeduplicationDecision"
    },
    "duration": {
      "description": "Video length in milliseconds, when known",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "height": {
      "description": "Height in pixels, when known",
      "maximum": 9007199254740991,
      "minimum": 0,
      "nullable": true,
      "type": "integer"
    },
    "originalFileName": {
      "type": "string"
    },
    "originalPath": {
      "description": "Path of the duplicate copy on disk",
      "type": "string"
    },
    "ownerId": {
      "type": "string"
    },
    "ownerName": {
      "description": "Display name of the copy owner",
      "type": "string"
    },
    "reason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PhysicalDeduplicationSkipReason"
        }
      ],
      "description": "Present when the decision is skip",
      "nullable": true
    },
    "retainedAssetId": {
      "description": "Retained original this copy matches, if any",
      "nullable": true,
      "type": "string"
    },
    "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",
    "checksumMatch",
    "decision",
    "duration",
    "height",
    "originalFileName",
    "originalPath",
    "ownerId",
    "ownerName",
    "reason",
    "retainedAssetId",
    "sizeInBytes",
    "type",
    "width"
  ],
  "type": "object"
}