Skip to content

PreservationScopeDto

Endpoints · All schemas

What to preserve. Only your own items are ever included: never a partner’s or a shared album’s.

FieldRequiredDescription
assetIdsNoExactly these items of yours, instead of a filter
filterNoYour items matching these conditions; the whole library when empty

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

{
  "description": "What to preserve. Only your own items are ever included: never a partner’s or a shared album’s.",
  "properties": {
    "assetIds": {
      "description": "Exactly these items of yours, instead of a filter",
      "items": {
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        "type": "string"
      },
      "maxItems": 100000,
      "minItems": 1,
      "type": "array"
    },
    "filter": {
      "$ref": "#/components/schemas/SearchFilter",
      "description": "Your items matching these conditions; the whole library when empty"
    }
  },
  "type": "object"
}