/v2/exportmanager/list/run_statusExportlauf-Fortschritt lesen
Liest ausschließlich einen Lauf des authentifizierten Kontos und Administrators. Liefert Status, Fortschritt, Zeilenzahl und nach Abschluss eine Download-URL, sofern Datei und Quellzugriff weiterhin verfügbar sind.
Operation-ID get_v2_exportmanager_list_run_status
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Ja
read
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Parameter
Header
languageoptionalAccount language code, where the resource supports setLanguage().
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}Query-Parameter
runerforderlichLauf-ID aus POST /exportmanager/list/run.
Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.
- pattern
"^exportrun_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"exportrun_012345abcdef_123456"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^exportrun_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportrun_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
}Beispiel
"exportrun_012345abcdef_123456"Request Body
Kein Request Body in der Spezifikation beschrieben.
Antworten
9HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
Synchroner HTTP-200-JSON-Umschlag des asynchronen Exportlaufs bzw. seines aktuellen Zustands. Dieser Quellpfad antwortet nicht mit HTTP 202.
application/json
data object Exportmanager::serializeRun: Die neun Pflichtfelder werden immer geliefert. finalizing erscheint öffentlich als running; ein Download-Link wird nur bei completed und weiter bestehenden Berechtigungen ausgegeben.
run string erforderlich Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.
- pattern
"^exportrun_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"exportrun_012345abcdef_123456"export string erforderlich Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.
- pattern
"^exportmanager_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"exportmanager_012345abcdef_123456"status Typ nicht eingeschränkt erforderlich "queued""running""completed""empty""failed"progress integer erforderlich - minimum
0- maximum
100
row_count integer erforderlich - minimum
0
format Typ nicht eingeschränkt erforderlich Fester Wert: "csv"
created_at integer erforderlich started_at integer erforderlich completed_at integer erforderlich download_url string Exposed only for a completed run with requester/source rights and an existing owned secure export file.
- format
"uri"
error_code Typ nicht eingeschränkt "custom_export_failed""no_matching_records"Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
error boolean | string success boolean type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"run",
"export",
"status",
"progress",
"row_count",
"format",
"created_at",
"started_at",
"completed_at"
],
"properties": {
"run": {
"type": "string",
"pattern": "^exportrun_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportrun_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
},
"export": {
"type": "string",
"pattern": "^exportmanager_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportmanager_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
},
"status": {
"enum": [
"queued",
"running",
"completed",
"empty",
"failed"
]
},
"progress": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"row_count": {
"type": "integer",
"minimum": 0
},
"format": {
"const": "csv"
},
"created_at": {
"type": "integer"
},
"started_at": {
"type": "integer"
},
"completed_at": {
"type": "integer"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "Exposed only for a completed run with requester/source rights and an existing owned secure export file."
},
"error_code": {
"enum": [
"custom_export_failed",
"no_matching_records"
]
}
},
"additionalProperties": true,
"description": "Exportmanager::serializeRun: Die neun Pflichtfelder werden immer geliefert. finalizing erscheint öffentlich als running; ein Download-Link wird nur bei completed und weiter bestehenden Berechtigungen ausgegeben."
},
"error": {
"type": [
"boolean",
"string"
]
},
"success": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"data": {
"run": "exportrun_012345abcdef_123456",
"export": "exportmanager_012345abcdef_123456",
"status": "queued",
"progress": 0,
"row_count": 0,
"format": "csv",
"created_at": 1792627200,
"started_at": 0,
"completed_at": 0
},
"error": false,
"success": true,
"type": "exportmanager"
}400application/json
Invalid request.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40006"
}401application/json
Missing/expired token, missing account context, account paused or model-specific authorization failure.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40103"
}402application/json
Missing/invalid action data or subscription/operation restriction.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80100"
}403application/json
Permission denied. Browser CORS rejection may have an empty body.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED40340"
}404application/json
Unknown resource/action or unsupported method.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}422application/json
Validation failed.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80020"
}429application/json
Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.
Response Header
Retry-After
Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED42902"
}502application/json
Server-side operation failed.
application/json
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}Quelle & Metadaten
application/models/v2/Exportmanager.php:61getExportmanager()Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.
x-edoobox-mutates-state
falsex-edoobox-contract-evidence
[
{
"file": "application/models/v2/Exportmanager.php",
"line": 262
},
{
"file": "application/models/v2/Exportmanager.php",
"line": 1549
}
]x-edoobox-mutationReview
{
"source": {
"file": "application/models/v2/Exportmanager.php",
"line": 61
},
"reason": "Read definitions, catalogs, existing run status or completed output; no job processing in these GET branches."
}x-edoobox-runtimeMutationGuard
falsex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/08-subscriptions.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Exportmanager.php",
"method": "getExportmanager",
"line": 61,
"branch": {
"file": "application/models/v2/Exportmanager.php",
"line": 69
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "exportmanager",
"short": "expm",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}Vollständige Operation als JSON
{
"operationId": "get_v2_exportmanager_list_run_status",
"summary": "Exportlauf-Fortschritt lesen",
"description": "Liest ausschließlich einen Lauf des authentifizierten Kontos und Administrators. Liefert Status, Fortschritt, Zeilenzahl und nach Abschluss eine Download-URL, sofern Datei und Quellzugriff weiterhin verfügbar sind.",
"tags": [
"exportmanager"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
},
{
"name": "run",
"in": "query",
"required": true,
"schema": {
"type": "string",
"pattern": "^exportrun_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportrun_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
},
"example": "exportrun_012345abcdef_123456",
"description": "Lauf-ID aus POST /exportmanager/list/run."
}
],
"responses": {
"200": {
"description": "Synchroner HTTP-200-JSON-Umschlag des asynchronen Exportlaufs bzw. seines aktuellen Zustands. Dieser Quellpfad antwortet nicht mit HTTP 202.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"run",
"export",
"status",
"progress",
"row_count",
"format",
"created_at",
"started_at",
"completed_at"
],
"properties": {
"run": {
"type": "string",
"pattern": "^exportrun_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportrun_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
},
"export": {
"type": "string",
"pattern": "^exportmanager_[a-f0-9]{12}_-?[0-9]+$",
"examples": [
"exportmanager_012345abcdef_123456"
],
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
},
"status": {
"enum": [
"queued",
"running",
"completed",
"empty",
"failed"
]
},
"progress": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"row_count": {
"type": "integer",
"minimum": 0
},
"format": {
"const": "csv"
},
"created_at": {
"type": "integer"
},
"started_at": {
"type": "integer"
},
"completed_at": {
"type": "integer"
},
"download_url": {
"type": "string",
"format": "uri",
"description": "Exposed only for a completed run with requester/source rights and an existing owned secure export file."
},
"error_code": {
"enum": [
"custom_export_failed",
"no_matching_records"
]
}
},
"additionalProperties": true,
"description": "Exportmanager::serializeRun: Die neun Pflichtfelder werden immer geliefert. finalizing erscheint öffentlich als running; ein Download-Link wird nur bei completed und weiter bestehenden Berechtigungen ausgegeben."
},
"error": {
"type": [
"boolean",
"string"
]
},
"success": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"example": {
"data": {
"run": "exportrun_012345abcdef_123456",
"export": "exportmanager_012345abcdef_123456",
"status": "queued",
"progress": 0,
"row_count": 0,
"format": "csv",
"created_at": 1792627200,
"started_at": 0,
"completed_at": 0
},
"error": false,
"success": true,
"type": "exportmanager"
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40006"
}
}
}
},
"401": {
"description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40103"
}
}
}
},
"402": {
"description": "Missing/invalid action data or subscription/operation restriction.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80100"
}
}
}
},
"403": {
"description": "Permission denied. Browser CORS rejection may have an empty body.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40340"
}
}
}
},
"404": {
"description": "Unknown resource/action or unsupported method.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80019"
}
}
}
},
"422": {
"description": "Validation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80020"
}
}
}
},
"429": {
"description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED42902"
}
}
},
"headers": {
"Retry-After": {
"description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
"schema": {
"type": "string",
"examples": [
"30"
]
}
}
}
},
"502": {
"description": "Server-side operation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED50201"
}
}
}
}
},
"x-edoobox-mutates-state": false,
"x-edoobox-contract-evidence": [
{
"file": "application/models/v2/Exportmanager.php",
"line": 262
},
{
"file": "application/models/v2/Exportmanager.php",
"line": 1549
}
],
"x-edoobox-mutationReview": {
"source": {
"file": "application/models/v2/Exportmanager.php",
"line": 61
},
"reason": "Read definitions, catalogs, existing run status or completed output; no job processing in these GET branches."
},
"x-edoobox-runtimeMutationGuard": false,
"x-edoobox-get-effect": "read",
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/08-subscriptions.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Exportmanager.php",
"method": "getExportmanager",
"line": 61,
"branch": {
"file": "application/models/v2/Exportmanager.php",
"line": 69
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "exportmanager",
"short": "expm",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
}