/v2/task/list/LUTVerfügbare Aufgabenfunktionen lesen
Liefert den eingebauten Katalog für task_func: Erinnerungs-, Bestätigungs-, Freigabe-, Absage- und Zertifikatsmails, Sammeldatei sowie Zahlungs-/Rechnungsaufgaben. Die kleinen numerischen id-Werte sind Funktionscodes aus diesem Katalog, keine Datenbank-IDs. Eigene emailtemplate-Funktionen werden in diesem Katalog nicht aufgezählt.
Operation-ID get_v2_task_list_LUT
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"
]
}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
Liste von Übersetzungscode und task_func-Objekt.
application/json
success boolean error boolean | string error_code string data array Array-Elemente
text_code string erforderlich data Typ nicht eingeschränkt erforderlich Built-in task IDs are function selectors, not database record IDs. Email-template tasks require a public emailtemplate ID for a usable mail template.
anyOf · Mindestens eine Variante muss passen
Variante 1 object func Typ nicht eingeschränkt erforderlich Fester Wert: "mail"
id Typ nicht eingeschränkt erforderlich Source-defined mail function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.
anyOf · Mindestens eine Variante muss passen
Variante 1 integer 12345Variante 2 string "1""2""3""4""5"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-id-kind": "builtin-task-function"
}Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 object func Typ nicht eingeschränkt erforderlich Fester Wert: "job"
id Typ nicht eingeschränkt erforderlich Source-defined job function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.
anyOf · Mindestens eine Variante muss passen
Variante 1 integer 1Variante 2 string "1"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-id-kind": "builtin-task-function"
}Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 3 object func Typ nicht eingeschränkt erforderlich Fester Wert: "financ"
id Typ nicht eingeschränkt erforderlich Source-defined financ function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.
anyOf · Mindestens eine Variante muss passen
Variante 1 integer 123Variante 2 string "1""2""3"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-id-kind": "builtin-task-function"
}Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 4 object func Typ nicht eingeschränkt erforderlich Fester Wert: "emailtemplate"
id string erforderlich Öffentliche emailtemplate_-ID einer verwendbaren E-Mail-Vorlagenfamilie desselben Kontos. Diese Ausnahme verwendet eine v2-ID statt eines eingebauten numerischen Funktionscodes; PDF-Vorlagen sind unzulässig.
- pattern
"^emailtemplate_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"emailtemplate_012345abcdef_123456"Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text_code": {
"type": "string"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"func": {
"const": "mail"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1,
2,
3,
4,
5
]
},
{
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
}
],
"description": "Source-defined mail function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "job"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1
]
},
{
"type": "string",
"enum": [
"1"
]
}
],
"description": "Source-defined job function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "financ"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1,
2,
3
]
},
{
"type": "string",
"enum": [
"1",
"2",
"3"
]
}
],
"description": "Source-defined financ function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "emailtemplate"
},
"id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche emailtemplate_-ID einer verwendbaren E-Mail-Vorlagenfamilie desselben Kontos. Diese Ausnahme verwendet eine v2-ID statt eines eingebauten numerischen Funktionscodes; PDF-Vorlagen sind unzulässig.",
"examples": [
"emailtemplate_012345abcdef_123456"
]
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
}
],
"description": "Built-in task IDs are function selectors, not database record IDs. Email-template tasks require a public emailtemplate ID for a usable mail template."
}
},
"additionalProperties": true,
"required": [
"text_code",
"data"
]
}
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": [
{
"text_code": "N12128",
"data": {
"func": "mail",
"id": 1
}
}
]
}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/Task.php:393getTask()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-mutationReview
{
"source": {
"file": "application/models/v2/Adminconfig.php",
"line": 154
},
"reason": "Local Structure selection and GET_data, or literal task lookup values; no domain writes."
}x-edoobox-runtimeMutationGuard
falsex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/09-messages-ai.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Task.php",
"method": "getTask",
"line": 393,
"branch": {
"file": "application/models/v2/Task.php",
"line": 398
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
truex-edoobox-permission
{
"resource": "task",
"short": "task",
"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_task_list_LUT",
"summary": "Verfügbare Aufgabenfunktionen lesen",
"description": "Liefert den eingebauten Katalog für task_func: Erinnerungs-, Bestätigungs-, Freigabe-, Absage- und Zertifikatsmails, Sammeldatei sowie Zahlungs-/Rechnungsaufgaben. Die kleinen numerischen id-Werte sind Funktionscodes aus diesem Katalog, keine Datenbank-IDs. Eigene emailtemplate-Funktionen werden in diesem Katalog nicht aufgezählt.",
"tags": [
"task"
],
"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"
]
}
}
],
"responses": {
"200": {
"description": "Liste von Übersetzungscode und task_func-Objekt.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": [
{
"text_code": "N12128",
"data": {
"func": "mail",
"id": 1
}
}
]
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text_code": {
"type": "string"
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"func": {
"const": "mail"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1,
2,
3,
4,
5
]
},
{
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
]
}
],
"description": "Source-defined mail function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "job"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1
]
},
{
"type": "string",
"enum": [
"1"
]
}
],
"description": "Source-defined job function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "financ"
},
"id": {
"anyOf": [
{
"type": "integer",
"enum": [
1,
2,
3
]
},
{
"type": "string",
"enum": [
"1",
"2",
"3"
]
}
],
"description": "Source-defined financ function selector, not a database record ID; only the paired func-specific enum values are supported. Funktionscode des gewählten Aufgabentyps; keine Datenbank-ID.",
"x-edoobox-id-kind": "builtin-task-function"
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
},
{
"type": "object",
"properties": {
"func": {
"const": "emailtemplate"
},
"id": {
"type": "string",
"pattern": "^emailtemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche emailtemplate_-ID einer verwendbaren E-Mail-Vorlagenfamilie desselben Kontos. Diese Ausnahme verwendet eine v2-ID statt eines eingebauten numerischen Funktionscodes; PDF-Vorlagen sind unzulässig.",
"examples": [
"emailtemplate_012345abcdef_123456"
]
}
},
"additionalProperties": true,
"required": [
"func",
"id"
]
}
],
"description": "Built-in task IDs are function selectors, not database record IDs. Email-template tasks require a public emailtemplate ID for a usable mail template."
}
},
"additionalProperties": true,
"required": [
"text_code",
"data"
]
}
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
}
}
},
"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-mutationReview": {
"source": {
"file": "application/models/v2/Adminconfig.php",
"line": 154
},
"reason": "Local Structure selection and GET_data, or literal task lookup values; no domain writes."
},
"x-edoobox-runtimeMutationGuard": false,
"x-edoobox-get-effect": "read",
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/09-messages-ai.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Task.php",
"method": "getTask",
"line": 393,
"branch": {
"file": "application/models/v2/Task.php",
"line": 398
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": true,
"x-edoobox-permission": {
"resource": "task",
"short": "task",
"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."
}
}