curl --request GET \ --url 'https://app.output.rocks/api/spa/archive?page=1&itemsPerPage=20&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", "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" } ]

ArchiveEntry

Retrieves the collection of ArchiveEntry resources.

GET/api/spa/archive

Retrieves the collection of ArchiveEntry resources.

curl --request GET \
  --url 'https://app.output.rocks/api/spa/archive?page=1&itemsPerPage=20&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",
    "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.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

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).

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"