Archive

Create tenant retention class

Requires explicit protection token permission.

POST/api/archive/retention-classes

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth
oauth2oauth2required

No description provided.

Request Body

application/json
required
{
  "code": "string",
  "name": "Example name",
  "durationYears": 1,
  "startMode": "document-year-end",
  "deletionMode": "automatic",
  "description": "Example description",
  "legalBasis": "string",
  "statutory": true,
  "reconciliationPending": 1,
  "reconciliationUrgent": 1
}

Response

201application/json

Fully stored; existing response fields id, fileName, state, sha256, retentionFloorUntil, dispositionDate and link.

code
stringrequired
name
stringrequired
durationYears
integerrequired
startMode
enum<string>required

Available options: document-year-enddocument-dateevent

deletionMode
enum<string>required

Available options: automaticmanual

description
string | null
legalBasis
string | null
statutory
boolean

Available options: truefalse

reconciliationPending
integer
reconciliationUrgent
integer