ErasurePreview

Fields

11 fields

blockers

array of ErasureBlocker

changes · required

array of ErasureLocationCount

display · required

string

erasure_job

SubjectJobRead or null

is_active · required

boolean

kept · required

array of ErasureLocationCount

open_items

array of ErasureLocationCount

pseudonym · required

string

role · required

string

user_id · required

string (uuid)

username · required

string

Raw schema (JSON)

{
  "properties": {
    "blockers": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/ErasureBlocker"
      },
      "title": "Blockers",
      "type": "array"
    },
    "changes": {
      "items": {
        "$ref": "#/components/schemas/ErasureLocationCount"
      },
      "title": "Changes",
      "type": "array"
    },
    "display": {
      "title": "Display",
      "type": "string"
    },
    "erasure_job": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/SubjectJobRead"
        },
        {
          "type": "null"
        }
      ]
    },
    "is_active": {
      "title": "Is Active",
      "type": "boolean"
    },
    "kept": {
      "items": {
        "$ref": "#/components/schemas/ErasureLocationCount"
      },
      "title": "Kept",
      "type": "array"
    },
    "open_items": {
      "default": [],
      "items": {
        "$ref": "#/components/schemas/ErasureLocationCount"
      },
      "title": "Open Items",
      "type": "array"
    },
    "pseudonym": {
      "title": "Pseudonym",
      "type": "string"
    },
    "role": {
      "title": "Role",
      "type": "string"
    },
    "user_id": {
      "format": "uuid",
      "title": "User Id",
      "type": "string"
    },
    "username": {
      "title": "Username",
      "type": "string"
    }
  },
  "required": [
    "user_id",
    "username",
    "display",
    "role",
    "is_active",
    "pseudonym",
    "changes",
    "kept"
  ],
  "title": "ErasurePreview",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• GET /api/v1/users/{user_id}/erasure-preview — Get Erasure Preview

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON