PreservationPreviewResponseDto

Endpoints · All schemas

Field	Required	Description
bytes	Yes	string
freeBytes	Yes	Free space where the package would be written
includedBytes	Yes	string
includedItems	Yes	Items the export would include
items	Yes	Items matching, Locked ones not counted
lockedAllowed	Yes	This session is unlocked, so Locked items may be included
lockedBytes	Yes	string
lockedItems	Yes	Locked items matching
maxItems	Yes	integer
support	Yes	array
withinLimit	Yes	boolean

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: PreservationSupportDto

{
  "properties": {
    "bytes": {
      "type": "string"
    },
    "freeBytes": {
      "description": "Free space where the package would be written",
      "nullable": true,
      "type": "string"
    },
    "includedBytes": {
      "type": "string"
    },
    "includedItems": {
      "description": "Items the export would include",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "items": {
      "description": "Items matching, Locked ones not counted",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "lockedAllowed": {
      "description": "This session is unlocked, so Locked items may be included",
      "type": "boolean"
    },
    "lockedBytes": {
      "type": "string"
    },
    "lockedItems": {
      "description": "Locked items matching",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "maxItems": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "support": {
      "items": {
        "$ref": "#/components/schemas/PreservationSupportDto"
      },
      "type": "array"
    },
    "withinLimit": {
      "type": "boolean"
    }
  },
  "required": [
    "bytes",
    "freeBytes",
    "includedBytes",
    "includedItems",
    "items",
    "lockedAllowed",
    "lockedBytes",
    "lockedItems",
    "maxItems",
    "support",
    "withinLimit"
  ],
  "type": "object"
}