TabGeckoPATCH
/api/v1/trash/{id}
Endlöschung aussetzen oder fortsetzen
Anfrage#
POSIX-Shell · curl
curl --fail-with-body --request PATCH \
"$ADBR_API_URL/api/v1/trash/{id}" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonVerwende 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#
| Parameter | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Anfragekörper#
Erforderlich.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
purge_hold | boolean | Ja |
Vollständiges Körperschema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"purge_hold"
],
"properties": {
"purge_hold": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Antworten#
200 · Standardantwort
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"no",
"name",
"folder_key",
"engine",
"origin_group",
"tags",
"deleted_at",
"deleted_by",
"delete_source",
"purge_after",
"purge_hold",
"size_bytes",
"state",
"remaining_ms",
"proxy_in_trash",
"purge_error"
],
"properties": {
"id": {
"type": "string"
},
"no": {
"type": "integer"
},
"name": {
"type": "string"
},
"folder_key": {
"type": "string"
},
"engine": {
"type": "string"
},
"origin_group": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"deleted_at": {
"type": "integer"
},
"deleted_by": {
"type": [
"null",
"string"
]
},
"delete_source": {
"type": [
"null",
"string"
]
},
"purge_after": {
"type": [
"null",
"integer"
]
},
"purge_hold": {
"type": "boolean"
},
"size_bytes": {
"type": [
"null",
"integer"
]
},
"state": {
"type": "string"
},
"remaining_ms": {
"type": [
"null",
"integer"
]
},
"proxy_in_trash": {
"type": "boolean"
},
"purge_error": {
"type": [
"null",
"string"
]
}
}
}
}
}
}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": "Endlöschung aussetzen oder fortsetzen",
"tags": [
"Papierkorb"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"purge_hold"
],
"properties": {
"purge_hold": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"trash:manage"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"no",
"name",
"folder_key",
"engine",
"origin_group",
"tags",
"deleted_at",
"deleted_by",
"delete_source",
"purge_after",
"purge_hold",
"size_bytes",
"state",
"remaining_ms",
"proxy_in_trash",
"purge_error"
],
"properties": {
"id": {
"type": "string"
},
"no": {
"type": "integer"
},
"name": {
"type": "string"
},
"folder_key": {
"type": "string"
},
"engine": {
"type": "string"
},
"origin_group": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"deleted_at": {
"type": "integer"
},
"deleted_by": {
"type": [
"null",
"string"
]
},
"delete_source": {
"type": [
"null",
"string"
]
},
"purge_after": {
"type": [
"null",
"integer"
]
},
"purge_hold": {
"type": "boolean"
},
"size_bytes": {
"type": [
"null",
"integer"
]
},
"state": {
"type": "string"
},
"remaining_ms": {
"type": [
"null",
"integer"
]
},
"proxy_in_trash": {
"type": "boolean"
},
"purge_error": {
"type": [
"null",
"string"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}