SubjectJobRead

Fields

One personal-data export / erasure job. storage_key is NEVER part of it.

20 fields

bytes

integer or null

count_labels

object or null

counts

object

download_path

string or null

error

SubjectRightsError or null

expires_at

string (date-time) or null

file_count

integer or null

finished_at

string (date-time) or null

id · required

string (uuid)

kind · required

string

manifest_sha256

string or null

phase

string or null

requested_at · required

string (date-time)

requested_by_display

string or null

signature

string or null

source · required

string

started_at

string (date-time) or null

status · required

string

subject_display

string or null

subject_user_id

string (uuid) or null

Raw schema (JSON)

{
  "description": "One personal-data export / erasure job. ``storage_key`` is NEVER part of it.",
  "properties": {
    "bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bytes"
    },
    "count_labels": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Count Labels"
    },
    "counts": {
      "additionalProperties": {
        "type": "integer"
      },
      "default": {},
      "title": "Counts",
      "type": "object"
    },
    "download_path": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Download Path"
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/SubjectRightsError"
        },
        {
          "type": "null"
        }
      ]
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "file_count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "File Count"
    },
    "finished_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Finished At"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "manifest_sha256": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Manifest Sha256"
    },
    "phase": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Phase"
    },
    "requested_at": {
      "format": "date-time",
      "title": "Requested At",
      "type": "string"
    },
    "requested_by_display": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requested By Display"
    },
    "signature": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Signature"
    },
    "source": {
      "title": "Source",
      "type": "string"
    },
    "started_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Started At"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "subject_display": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Subject Display"
    },
    "subject_user_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Subject User Id"
    }
  },
  "required": [
    "id",
    "kind",
    "status",
    "source",
    "requested_at"
  ],
  "title": "SubjectJobRead",
  "type": "object"
}

Used by endpoints

7 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/me/data-export — Start My Data Export
• GET /api/v1/subject-data-jobs/{subject_job_id} — Get Subject Data Job
• POST /api/v1/users/{user_id}/data-export — Start User Data Export
• POST /api/v1/users/{user_id}/erasure — Erase User
• GET /api/v1/me/data-exports — List My Data Exports
• GET /api/v1/users/{user_id}/data-jobs — List User Data Jobs
• GET /api/v1/users/{user_id}/erasure-preview — Get Erasure Preview

Used by schemas

• ErasurePreview
• SubjectJobList

More details

• Specification: OpenAPI JSON