ArchiveEntry

Retrieves a ArchiveEntry resource.

GET/api/archive/{id}

Retrieves a ArchiveEntry resource.

curl --request GET \
  --url 'https://app.output.rocks/api/archive/string' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 123,
  "fileName": "Example name",
  "sourceType": "string",
  "externalId": "string",
  "sha256": "string",
  "sizeBytes": 1,
  "originalFormat": "2024-08-23T00:00:00+00:00",
  "legalClass": "<string>",
  "retentionFloorUntil": "2024-08-23T00:00:00+00:00",
  "dispositionDate": "2024-08-23T00:00:00+00:00",
  "legalHold": true,
  "metadata": [
    "string"
  ],
  "state": "pending",
  "renderProcessId": 123,
  "emailProcessId": 123,
  "xmlProcessId": 123,
  "createdAt": "2024-08-23T00:00:00+00:00",
  "updatedAt": "2024-08-23T00:00:00+00:00"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

ArchiveEntry identifier

Response

200application/json

ArchiveEntry resource

integer

fileName

string

Human-readable name of the archived file.

sourceType

string

externalId

string | null

Original system reference (e.g. RenderProcess externalId).

sha256

string | null

sizeBytes

value

originalFormat

string | null

legalClass

string

retentionFloorUntil

string<date-time>

Storage-enforced minimum retention (S3 Object Lock retain-until). Extend-only, never shortenable.

dispositionDate

string<date-time> | null

Advisory user-chosen deletion date (Löschzeitpunkt). Clamped server-side to >= retentionFloorUntil.

legalHold

boolean

Available options: truefalse

metadata

string[]

state

string

Example: "pending"

renderProcessId

integer | null

emailProcessId

integer | null

xmlProcessId

integer | null

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"