curl --request GET \ --url 'https://app.output.rocks/api/archive?page=1&order%5Bid%5D=asc&order%5BfileName%5D=asc&order%5BsourceType%5D=asc&order%5BlegalClass%5D=asc&order%5BretentionFloorUntil%5D=asc&order%5BdispositionDate%5D=asc&order%5BcreatedAt%5D=asc' \ --header 'X-AUTH-TOKEN: <api-key>'

[ { "id": 123, "fileName": "Example name", "sourceType": "string", "externalId": "string", "s3Bucket": "string", "s3Key": "string", "s3VersionId": "string", "sha256": "string", "crc64nvme": "string", "sizeBytes": 1, "originalFormat": "2024-08-23T00:00:00+00:00", "normalizedFormat": "2024-08-23T00:00:00+00:00", "eInvoiceXmlS3Key": "string", "eInvoiceXmlS3VersionId": "string", "validationReportS3Key": "string", "validationReportS3VersionId": "string", "legalClass": "<string>", "retentionFloorUntil": "2024-08-23T00:00:00+00:00", "dispositionDate": "2024-08-23T00:00:00+00:00", "legalHold": false, "legalHoldReason": "string", "legalHoldBy": "string", "legalHoldAt": "2024-08-23T00:00:00+00:00", "metadata": [ "string" ], "state": "pending", "workflowLog": "", "blocked": false, "wfData": [ "string" ], "batchAction": "https://example.com/", "dispositionCertificateS3Key": "string", "dispositionCertificateS3VersionId": "string", "disposedAt": "2024-08-23T00:00:00+00:00", "renderProcessId": 123, "emailProcessId": 123, "xmlProcessId": 123, "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "client": {}, "subClient": {}, "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

ArchiveEntry

Retrieves the collection of ArchiveEntry resources.

GET/api/archive

Retrieves the collection of ArchiveEntry resources.

curl --request GET \
  --url 'https://app.output.rocks/api/archive?page=1&order%5Bid%5D=asc&order%5BfileName%5D=asc&order%5BsourceType%5D=asc&order%5BlegalClass%5D=asc&order%5BretentionFloorUntil%5D=asc&order%5BdispositionDate%5D=asc&order%5BcreatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "fileName": "Example name",
    "sourceType": "string",
    "externalId": "string",
    "s3Bucket": "string",
    "s3Key": "string",
    "s3VersionId": "string",
    "sha256": "string",
    "crc64nvme": "string",
    "sizeBytes": 1,
    "originalFormat": "2024-08-23T00:00:00+00:00",
    "normalizedFormat": "2024-08-23T00:00:00+00:00",
    "eInvoiceXmlS3Key": "string",
    "eInvoiceXmlS3VersionId": "string",
    "validationReportS3Key": "string",
    "validationReportS3VersionId": "string",
    "legalClass": "<string>",
    "retentionFloorUntil": "2024-08-23T00:00:00+00:00",
    "dispositionDate": "2024-08-23T00:00:00+00:00",
    "legalHold": false,
    "legalHoldReason": "string",
    "legalHoldBy": "string",
    "legalHoldAt": "2024-08-23T00:00:00+00:00",
    "metadata": [
      "string"
    ],
    "state": "pending",
    "workflowLog": "",
    "blocked": false,
    "wfData": [
      "string"
    ],
    "batchAction": "https://example.com/",
    "dispositionCertificateS3Key": "string",
    "dispositionCertificateS3VersionId": "string",
    "disposedAt": "2024-08-23T00:00:00+00:00",
    "renderProcessId": 123,
    "emailProcessId": 123,
    "xmlProcessId": 123,
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "client": {},
    "subClient": {},
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

pagination

boolean

Enable or disable pagination

order[id]

stringdefault:asc

No description provided.

order[fileName]

stringdefault:asc

No description provided.

order[sourceType]

stringdefault:asc

No description provided.

order[legalClass]

stringdefault:asc

No description provided.

order[retentionFloorUntil]

stringdefault:asc

No description provided.

order[dispositionDate]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

integer

No description provided.

id[]

integer[]

No description provided.

fileName

string

No description provided.

externalId

string

No description provided.

sourceType

string

No description provided.

sourceType[]

string[]

No description provided.

legalClass

string

No description provided.

legalClass[]

string[]

No description provided.

state

string

No description provided.

state[]

string[]

No description provided.

legalHold

boolean

No description provided.

createdAt[before]

string

No description provided.

createdAt[strictly_before]

string

No description provided.

createdAt[after]

string

No description provided.

createdAt[strictly_after]

string

No description provided.

retentionFloorUntil[before]

string

No description provided.

retentionFloorUntil[strictly_before]

string

No description provided.

retentionFloorUntil[after]

string

No description provided.

retentionFloorUntil[strictly_after]

string

No description provided.

dispositionDate[before]

string

No description provided.

dispositionDate[strictly_before]

string

No description provided.

dispositionDate[after]

string

No description provided.

dispositionDate[strictly_after]

string

No description provided.

string

Case-insensitive partial search across file name, external id, source type, legal class and state.

metadata[key]

string

Exact top-level archive metadata filter. Example: metadata[customerId]=C-100.

metadataLike[key]

string

Case-insensitive partial top-level archive metadata filter. Example: metadataLike[customerId]=C-10.

Response

200application/json

ArchiveEntry collection

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

sizeBytes

value | null

originalFormat

string | null

normalizedFormat

string | null

Path of the PDF/A normalization (phase 2; original bytes are always retained).

eInvoiceXmlS3Key

string | null

eInvoiceXmlS3VersionId

string | null

validationReportS3Key

string | null

validationReportS3VersionId

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

Example: false

legalHoldReason

string | null

legalHoldBy

string | null

legalHoldAt

string<date-time> | null

metadata

string | null[]

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"