> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# 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/{orderId}/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.



## OpenAPI

````yaml /es/openapi/v3-current/sisbajud-executor.yaml post /v1/admin/direct/purge
openapi: 3.1.0
info:
  description: >-
    API for Plugin SISBAJUD, which runs judicial orders on Midaz. It covers
    institution and Midaz connector configuration, orders that need attention,
    ledger-routing checks, credential key rotation and audit verification.
  title: Plugin SISBAJUD API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: >-
      Institution configuration lifecycle: create (with key provisioning), read,
      and partial update of a connector configuration addressed by institution
      id.
    name: Institution
  - description: >-
      Rotation of the key that wraps an institution's stored connector
      credentials, addressed by institution id.
    name: Security
  - description: 'Admin API: audit-trail integrity verification.'
    name: Admin
paths:
  /v1/admin/direct/purge:
    post:
      tags:
        - Direct Channel Administration
      summary: Preview the direct order purge (dry run)
      description: >-
        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/{orderId}/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.
      operationId: preview-direct-order-purge
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DirectPurgePreviewRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectPurgePreviewResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflict
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Request Entity Too Large
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Too Many Requests
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Service Unavailable
components:
  schemas:
    DirectPurgePreviewRequest:
      additionalProperties: false
      properties:
        dryRun:
          description: >-
            Must be true: the preview only lists the eligible orders; each erase
            is a separate request.
          examples:
            - true
          type: boolean
        limit:
          description: Most orders listed, 1 to 100; 0 or absent lists up to 100.
          examples:
            - 100
          format: int64
          type: integer
        reason:
          description: 'Required: retention-purge or lgpd-subject-request.'
          examples:
            - retention-purge
          type: string
        ticket:
          description: 'Required: the request id (at most 64 characters, no personal data).'
          examples:
            - PURGE-2026-10
          type: string
      type: object
    DirectPurgePreviewResponse:
      additionalProperties: false
      properties:
        asOf:
          description: Instant the eligibility was read (UTC).
          format: date-time
          type: string
        dryRun:
          description: 'Always true: nothing was erased.'
          type: boolean
        orderIds:
          description: >-
            Direct orders eligible for erasure as of asOf, oldest eligibility
            first.
          items:
            type: string
          type:
            - array
            - 'null'
        truncated:
          description: >-
            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).
          type: boolean
      required:
        - orderIds
        - dryRun
        - asOf
        - truncated
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        code:
          type: string
        details:
          additionalProperties: {}
          type: object
        message:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.