TabGeckoPOST
/api/v1/batch-operations/{id}/cancel
Noch nicht begonnene Profilaktionen abbrechen
Anfrage#
POSIX-Shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/batch-operations/{id}/cancel" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data '{}'Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.
Authentifizierung und Rechte#
Authentifizierung: Bearer-Token
Scopes: profiles:read
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",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "path",
"name": "id",
"required": true
}
]Anfragekörper#
Kein Anfragekörper deklariert.
Antworten#
200 · Standardantwort
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"active",
"cancelled",
"total",
"recovered",
"operation",
"updated_at",
"items"
],
"properties": {
"id": {
"type": "string"
},
"active": {
"type": "boolean"
},
"cancelled": {
"type": "boolean"
},
"total": {
"type": "integer"
},
"recovered": {
"type": "boolean"
},
"operation": {
"type": "string"
},
"updated_at": {
"type": "number"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"id",
"state",
"error"
],
"properties": {
"index": {
"type": "integer"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"completed",
"failed",
"cancelled",
"interrupted"
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
}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": "Noch nicht begonnene Profilaktionen abbrechen",
"tags": [
"Profile"
],
"parameters": [
{
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"profiles:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"active",
"cancelled",
"total",
"recovered",
"operation",
"updated_at",
"items"
],
"properties": {
"id": {
"type": "string"
},
"active": {
"type": "boolean"
},
"cancelled": {
"type": "boolean"
},
"total": {
"type": "integer"
},
"recovered": {
"type": "boolean"
},
"operation": {
"type": "string"
},
"updated_at": {
"type": "number"
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"index",
"id",
"state",
"error"
],
"properties": {
"index": {
"type": "integer"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"completed",
"failed",
"cancelled",
"interrupted"
]
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}