Archive a record

Archive a record: it leaves default lists but keeps its history and can be restored. With unlink_relations it also drops all its links to other records.

Authorization

bearerApiKey

AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

record_id*string

Resource identifier: record_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Idempotency-Key*string

A unique key for this intended write. Reuse it only for an identical retry.

Length1 <= length <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expected_revision*integer

Range1 <= value

unlink_relations?boolean

Also remove every link between this record and other records; restoring does not bring them back.

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/records/rows/123e4567-e89b-42d3-a456-426614174000/archive" \  -H "Idempotency-Key: 123e4567-e89b-42d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": 1  }'

{}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/problem+json

401application/problem+json

402application/problem+json

403application/problem+json

404application/problem+json

405application/problem+json

409application/problem+json

410application/problem+json

413application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

504application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`