Preview the direct order purge (dry run)

Lists up to limit (at most 100) direct orders eligible for erasure as of now, in the institutions this executor owns, oldest eligibility first; the same predicate as the purge-eligible gauge, the money rule and the parent rule of the erase. A permanent block’s permanentUntil lives only in its sealed body, so the erase may still refuse a listed permanent order (SBJ-0057). The preview is a dry run only: nothing is erased, and each erase is a separate POST …/orders//erase. A human platform-administrator action (direct_order_erasure:purge_preview): 403 SBJ-0044/SBJ-0045 for M2M or tenant-carrying tokens. 422 SBJ-0058: dryRun not true, limit out of range, reason or ticket invalid. 422 SBJ-0059: multi-tenant deployment.

POST /v1/admin/direct/purge

Preview the direct order purge (dry run)

cURL

curl --request POST \
  --url https://api.example.com/v1/admin/direct/purge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dryRun": true,
  "limit": 100,
  "reason": "retention-purge",
  "ticket": "PURGE-2026-10"
}
'

200

{
  "asOf": "2023-11-07T05:31:56Z",
  "dryRun": true,
  "orderIds": [
    "<string>"
  ],
  "truncated": true
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

dryRun · boolean

Must be true: the preview only lists the eligible orders; each erase is a separate request.

Ejemplo:

true

limit · integer<int64>

Most orders listed, 1 to 100; 0 or absent lists up to 100.

Ejemplo:

100

reason · string

Required: retention-purge or lgpd-subject-request.

Ejemplo:

"retention-purge"

ticket · string

Required: the request id (at most 64 characters, no personal data).

Ejemplo:

"PURGE-2026-10"

Respuesta

200

application/json

OK

asOf · string<date-time> · requerido

Instant the eligibility was read (UTC).

dryRun · boolean · requerido

Always true: nothing was erased.

orderIds · string[] | null · requerido

Direct orders eligible for erasure as of asOf, oldest eligibility first.

truncated · boolean · requerido

True when the listing stopped at its read bound before it found limit orders or ran out of candidates: more eligible orders may exist. Each listed order is one the erase would accept (eligibility and the money rule).