POST

/api/v1/trash/empty

Papierkorb leeren; bestätigte Anzahl zählt alle löschbaren Profile unabhängig von Filtern. Geschützte Profile nur mit include_held=true.

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/trash/empty" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: trash:manage

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper#

Erforderlich.

Feld	Typ	Pflicht	Beschreibung
`confirm_count`	`integer`	Ja
`include_held`	`boolean`	Nein

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "confirm_count"
        ],
        "properties": {
          "confirm_count": {
            "type": "integer",
            "minimum": 0
          },
          "include_held": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "results",
          "succeeded",
          "failed",
          "remaining"
        ],
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "index",
                "id",
                "ok"
              ],
              "properties": {
                "index": {
                  "type": "integer"
                },
                "id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "ok": {
                  "type": "boolean"
                },
                "no": {
                  "type": "integer"
                },
                "error": {
                  "type": "object",
                  "required": [
                    "code",
                    "message"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    },
                    "details": {
                      "type": "object",
                      "additionalProperties": {}
                    }
                  }
                }
              }
            }
          },
          "succeeded": {
            "type": "integer"
          },
          "failed": {
            "type": "integer"
          },
          "remaining": {
            "type": "object",
            "required": [
              "total",
              "eligible",
              "held",
              "processing"
            ],
            "properties": {
              "total": {
                "type": "integer"
              },
              "eligible": {
                "type": "integer"
              },
              "held": {
                "type": "integer"
              },
              "processing": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition

OpenAPI JSON

{
  "summary": "Papierkorb leeren; bestätigte Anzahl zählt alle löschbaren Profile unabhängig von Filtern. Geschützte Profile nur mit include_held=true.",
  "tags": [
    "Papierkorb"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "confirm_count"
          ],
          "properties": {
            "confirm_count": {
              "type": "integer",
              "minimum": 0
            },
            "include_held": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "trash:manage"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "results",
              "succeeded",
              "failed",
              "remaining"
            ],
            "properties": {
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "index",
                    "id",
                    "ok"
                  ],
                  "properties": {
                    "index": {
                      "type": "integer"
                    },
                    "id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "ok": {
                      "type": "boolean"
                    },
                    "no": {
                      "type": "integer"
                    },
                    "error": {
                      "type": "object",
                      "required": [
                        "code",
                        "message"
                      ],
                      "properties": {
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        },
                        "details": {
                          "type": "object",
                          "additionalProperties": {}
                        }
                      }
                    }
                  }
                }
              },
              "succeeded": {
                "type": "integer"
              },
              "failed": {
                "type": "integer"
              },
              "remaining": {
                "type": "object",
                "required": [
                  "total",
                  "eligible",
                  "held",
                  "processing"
                ],
                "properties": {
                  "total": {
                    "type": "integer"
                  },
                  "eligible": {
                    "type": "integer"
                  },
                  "held": {
                    "type": "integer"
                  },
                  "processing": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}