ArchiveEntry

Retrieves a ArchiveEntry resource.

Retrieves a ArchiveEntry resource.

GET/api/archive/{id}

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth
oauth2oauth2required

No description provided.

Path Parameters

id
stringrequired

ArchiveEntry identifier

Response

200application/json

ArchiveEntry resource

id
integer
fileName
string

Human-readable name of the archived file.

sourceType
string
externalId
string | null

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

s3Bucket
string | null

Populated once the entry transitions from pending to stored.

s3Key
string | null
s3VersionId
string | null

Version id of the Object-Lock-protected object version.

sha256
string | null
crc64nvme
string | null
malwareScanStatus
string

Example: "not_required"

malwareScanAttempts
integer

Example: 0

malwareScannedAt
string<date-time> | null
sizeBytes
value | null
originalFormat
string | null
normalizedFormat
string | null

Confirmed profile of a separate, protected PDF/A component.

pdfaStatus
string

Example: "not_required"

pdfaNormalizeRequested
boolean

Available options: truefalse

Example: false

pdfaValidation
string | null[] | null
pdfaError
string | null
eInvoiceXmlS3Key
string | null
eInvoiceXmlS3VersionId
string | null
validationReportS3Key
string | null
validationReportS3VersionId
string | null
legalClass
string
documentDate
string<date-time> | null
retentionEventDate
string<date-time> | null
retentionEventPending
boolean

Available options: truefalse

Example: false

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.

dispositionAuto
boolean

Available options: truefalse

Example: false

legalHold
boolean

Available options: truefalse

Example: false

manualLegalHold
boolean

An independent hold survives release of every case that also covers this entry.

Available options: truefalse

Example: false

legalHoldReason
string | null
legalHoldBy
string | null
legalHoldAt
string<date-time> | null
metadata
string | null[]
revision
integer

Zero means the legacy metadata has not yet been secured as a WORM revision.

Example: 0

state
string

Example: "pending"

workflowLog
string

Example: ""

blocked
boolean

Available options: truefalse

Example: false

wfData
string | null[]
batchAction
string<iri-reference> | null

Example: "https://example.com/"

dispositionCertificateS3Key
string | null

Tamper-evident disposition certificate retained after the content is deleted.

dispositionCertificateS3VersionId
string | null
disposedAt
string<date-time> | null
renderProcessId
integer | null
emailProcessId
integer | null
xmlProcessId
integer | null
createdBy
string

User, created this entry

Example: "user1@company.com"

updatedBy
string

User, updated this entry

Example: "user1@company.com"

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"

client
object
subClient
object
subClientId
integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription
string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor
string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"