PreservationItemDto

Endpoints · All schemas

Field	Required	Description
assetId	Yes	string
error	Yes	string
id	Yes	string
locked	Yes	boolean
name	Yes	string
reasonKey	Yes	string
sha256	Yes	string
sizeBytes	Yes	string
sourceAssetId	Yes	string
state	Yes	See definition below
verifyState	Yes	See definition below

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: PreservationItemState, PreservationVerifyState

{
  "properties": {
    "assetId": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "error": {
      "nullable": true,
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "locked": {
      "type": "boolean"
    },
    "name": {
      "nullable": true,
      "type": "string"
    },
    "reasonKey": {
      "nullable": true,
      "type": "string"
    },
    "sha256": {
      "nullable": true,
      "type": "string"
    },
    "sizeBytes": {
      "nullable": true,
      "type": "string"
    },
    "sourceAssetId": {
      "format": "uuid",
      "nullable": true,
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "state": {
      "$ref": "#/components/schemas/PreservationItemState"
    },
    "verifyState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PreservationVerifyState"
        }
      ],
      "nullable": true
    }
  },
  "required": [
    "assetId",
    "error",
    "id",
    "locked",
    "name",
    "reasonKey",
    "sha256",
    "sizeBytes",
    "sourceAssetId",
    "state",
    "verifyState"
  ],
  "type": "object"
}