Zum Inhalt
edoobox Docs

Suchen Sie nach einer Aufgabe oder einem Thema, z. B. Rechnung oder Warteliste.
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
taskAPI-Referenz
POST/v2/task

Geplante aufgabe anlegen

Plant eine E-Mail-, Finanz- oder Dokumentaufgabe für ein Angebot und legt eine verknüpfte Notiz an. offer, admin, task_func, task_name und date_run sind Pflicht. Zusätzlich user_all=true oder eine gültige user-Auswahl übergeben; die Legacy-Auswahlprüfung verlangt intern eine mehr als drei Zeichen lange ID-Liste. Ein zu früher Termin wird auf mindestens jetzt + 180 Sekunden verschoben. after_date_run ist nur für eigene E-Mail-Vorlagen erlaubt, nicht für eingebaute mail/financ/job-Funktionen. Eigene Vorlagen müssen E-Mail-Vorlagen sein. data erlaubt ein einzelnes Objekt oder höchstens 100 Objekte als Batch; die Antwort enthält eine ID bzw. eine ID-Liste.

Operation-ID post_v2_task

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein
02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing 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."
}
accountContextapiKey

Selected 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

sessionCookieapiKey

Existing 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."
}
accountContextapiKey

Selected 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."
}

Berechtigungen

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.

Ressource
task · task
Levels
2, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string
pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}
04

Request Body

erforderlich

application/json

object
data Typ nicht eingeschränkt erforderlich
anyOf · Mindestens eine Variante muss passen
Variante 1 object
offer string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^offer_[a-f0-9]{12}_-?[0-9]+$"
admin string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^admin_[a-f0-9]{12}_-?[0-9]+$"
note string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^note_[a-f0-9]{12}_-?[0-9]+$"
task_func 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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID.

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
Erlaubte Werte
12345
Variante 2 string
Erlaubte Werte
"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
Erlaubte Werte
1
Variante 2 string
Erlaubte Werte
"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
Erlaubte Werte
123
Variante 2 string
Erlaubte Werte
"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.

task_name string | number | boolean | null | array | object erforderlich

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel
"Erinnerung senden"
date_run string | number | boolean | null erforderlich

Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt.

status string | number | boolean | null | array | object

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel
"pending"
user array
Array-Elemente
string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
user_all string | number | boolean | null | array | object

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel
true
after_date_run string | number | boolean | null | array | object

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel
false
anyOf · Mindestens eine Variante muss passen
Variante 1 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: user_all

Variante 2 Typ nicht eingeschränkt
user Typ nicht eingeschränkt erforderlich
minItems
1

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 array
minItems
1
maxItems
100
Array-Elemente
object
offer string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^offer_[a-f0-9]{12}_-?[0-9]+$"
admin string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^admin_[a-f0-9]{12}_-?[0-9]+$"
note string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^note_[a-f0-9]{12}_-?[0-9]+$"
task_func 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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID.

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
Erlaubte Werte
12345
Variante 2 string
Erlaubte Werte
"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
Erlaubte Werte
1
Variante 2 string
Erlaubte Werte
"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
Erlaubte Werte
123
Variante 2 string
Erlaubte Werte
"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.

task_name string | number | boolean | null | array | object erforderlich

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel
"Erinnerung senden"
date_run string | number | boolean | null erforderlich

Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt.

status string | number | boolean | null | array | object

Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.

Schema-Beispiel
"pending"
user array
Array-Elemente
string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
user_all string | number | boolean | null | array | object

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel
true
after_date_run string | number | boolean | null | array | object

Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.

Schema-Beispiel
false
anyOf · Mindestens eine Variante muss passen
Variante 1 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: user_all

Variante 2 Typ nicht eingeschränkt
user Typ nicht eingeschränkt erforderlich
minItems
1

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "offer": {
              "type": "string",
              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "admin": {
              "type": "string",
              "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "note": {
              "type": "string",
              "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            "task_func": {
              "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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID."
            },
            "task_name": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
              "examples": [
                "Erinnerung senden"
              ]
            },
            "date_run": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ],
              "description": "Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt."
            },
            "status": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
              "examples": [
                "pending"
              ]
            },
            "user": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              }
            },
            "user_all": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
              "examples": [
                true
              ]
            },
            "after_date_run": {
              "type": [
                "string",
                "number",
                "boolean",
                "null",
                "array",
                "object"
              ],
              "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
              "examples": [
                false
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "offer",
            "admin",
            "task_func",
            "task_name",
            "date_run"
          ],
          "anyOf": [
            {
              "required": [
                "user_all"
              ]
            },
            {
              "required": [
                "user"
              ],
              "properties": {
                "user": {
                  "minItems": 1
                }
              }
            }
          ]
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "offer": {
                "type": "string",
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              },
              "admin": {
                "type": "string",
                "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              },
              "note": {
                "type": "string",
                "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              },
              "task_func": {
                "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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID."
              },
              "task_name": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                "examples": [
                  "Erinnerung senden"
                ]
              },
              "date_run": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null"
                ],
                "description": "Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt."
              },
              "status": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                "examples": [
                  "pending"
                ]
              },
              "user": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                }
              },
              "user_all": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                "examples": [
                  true
                ]
              },
              "after_date_run": {
                "type": [
                  "string",
                  "number",
                  "boolean",
                  "null",
                  "array",
                  "object"
                ],
                "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                "examples": [
                  false
                ]
              }
            },
            "additionalProperties": true,
            "required": [
              "offer",
              "admin",
              "task_func",
              "task_name",
              "date_run"
            ],
            "anyOf": [
              {
                "required": [
                  "user_all"
                ]
              },
              {
                "required": [
                  "user"
                ],
                "properties": {
                  "user": {
                    "minItems": 1
                  }
                }
              }
            ]
          },
          "minItems": 1,
          "maxItems": 100
        }
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
Geplante aufgabe anlegen
{
  "data": {
    "offer": "offer_012345abcdef_123456",
    "admin": "admin_012345abcdef_123456",
    "task_func": {
      "func": "mail",
      "id": 1
    },
    "task_name": "Erinnerung senden",
    "date_run": "2026-11-01T09:00:00+01:00",
    "user_all": true
  }
}
05

Antworten

11

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data.id enthält die neue öffentliche ID oder beim Batch eine Liste; insert zeigt das Ergebnis.

Response Header

X-Edoobox-Revision

Rotated account revision supplied for the next action in one reviewed sequence.

string
pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

application/json

object
success boolean
error boolean | string
error_code string
data object
id Typ nicht eingeschränkt erforderlich
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^task_[a-f0-9]{12}_-?[0-9]+$"
Variante 2 array
Array-Elemente
string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^task_[a-f0-9]{12}_-?[0-9]+$"
Variante 3 null
insert boolean erforderlich

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": "object",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^task_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
            },
            {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^task_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "insert": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "insert"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "task_012345abcdef_123456",
    "insert": true
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

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

Typ nicht eingeschränkt

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

Typ nicht eingeschränkt

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

Typ nicht eingeschränkt

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

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

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.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

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

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Task.php:342postTask()

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
true
x-edoobox-runtimeMutationGuard
true
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/09-messages-ai.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Task.php",
  "method": "postTask",
  "line": 342
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "task",
  "short": "task",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_task",
  "summary": "Geplante aufgabe anlegen",
  "description": "Plant eine E-Mail-, Finanz- oder Dokumentaufgabe für ein Angebot und legt eine verknüpfte Notiz an. offer, admin, task_func, task_name und date_run sind Pflicht. Zusätzlich user_all=true oder eine gültige user-Auswahl übergeben; die Legacy-Auswahlprüfung verlangt intern eine mehr als drei Zeichen lange ID-Liste. Ein zu früher Termin wird auf mindestens jetzt + 180 Sekunden verschoben. after_date_run ist nur für eigene E-Mail-Vorlagen erlaubt, nicht für eingebaute mail/financ/job-Funktionen. Eigene Vorlagen müssen E-Mail-Vorlagen sein. data erlaubt ein einzelnes Objekt oder höchstens 100 Objekte als Batch; die Antwort enthält eine ID bzw. eine ID-Liste.",
  "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"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data.id enthält die neue öffentliche ID oder beim Batch eine Liste; insert zeigt das Ergebnis.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "task_012345abcdef_123456",
              "insert": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^task_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^task_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "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"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "offer": {
                      "type": "string",
                      "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    },
                    "admin": {
                      "type": "string",
                      "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    },
                    "note": {
                      "type": "string",
                      "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                    },
                    "task_func": {
                      "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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID."
                    },
                    "task_name": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                      "examples": [
                        "Erinnerung senden"
                      ]
                    },
                    "date_run": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null"
                      ],
                      "description": "Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt."
                    },
                    "status": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                      "examples": [
                        "pending"
                      ]
                    },
                    "user": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      }
                    },
                    "user_all": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                      "examples": [
                        true
                      ]
                    },
                    "after_date_run": {
                      "type": [
                        "string",
                        "number",
                        "boolean",
                        "null",
                        "array",
                        "object"
                      ],
                      "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                      "examples": [
                        false
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "offer",
                    "admin",
                    "task_func",
                    "task_name",
                    "date_run"
                  ],
                  "anyOf": [
                    {
                      "required": [
                        "user_all"
                      ]
                    },
                    {
                      "required": [
                        "user"
                      ],
                      "properties": {
                        "user": {
                          "minItems": 1
                        }
                      }
                    }
                  ]
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "offer": {
                        "type": "string",
                        "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "admin": {
                        "type": "string",
                        "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "note": {
                        "type": "string",
                        "pattern": "^note_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                      },
                      "task_func": {
                        "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. Die Zahlencodes gelten ausschließlich zusammen mit ihrem jeweiligen func; eigene E-Mail-Vorlagen verwenden eine öffentliche emailtemplate_-ID."
                      },
                      "task_name": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 250 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                        "examples": [
                          "Erinnerung senden"
                        ]
                      },
                      "date_run": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null"
                        ],
                        "description": "Datum/Zeit als durch PHP strtotime lesbarer String empfohlen (ISO 8601). Ungültige Werte ergeben intern 0; bei Erstellung wird mindestens jetzt + 180 Sekunden gesetzt."
                      },
                      "status": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Text als String; Leerraum und Zeilenumbrüche werden normalisiert und auf 30 Zeichen gekürzt. Andere JSON-Typen werden vom Legacy-Setter zu leerem Text normalisiert.",
                        "examples": [
                          "pending"
                        ]
                      },
                      "user": {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
                        }
                      },
                      "user_all": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                        "examples": [
                          true
                        ]
                      },
                      "after_date_run": {
                        "type": [
                          "string",
                          "number",
                          "boolean",
                          "null",
                          "array",
                          "object"
                        ],
                        "description": "Wird nach PHP-Wahrheitswert zu true/false normalisiert; boolesche JSON-Werte verwenden.",
                        "examples": [
                          false
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "offer",
                      "admin",
                      "task_func",
                      "task_name",
                      "date_run"
                    ],
                    "anyOf": [
                      {
                        "required": [
                          "user_all"
                        ]
                      },
                      {
                        "required": [
                          "user"
                        ],
                        "properties": {
                          "user": {
                            "minItems": 1
                          }
                        }
                      }
                    ]
                  },
                  "minItems": 1,
                  "maxItems": 100
                }
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Geplante aufgabe anlegen",
            "value": {
              "data": {
                "offer": "offer_012345abcdef_123456",
                "admin": "admin_012345abcdef_123456",
                "task_func": {
                  "func": "mail",
                  "id": 1
                },
                "task_name": "Erinnerung senden",
                "date_run": "2026-11-01T09:00:00+01:00",
                "user_all": true
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/09-messages-ai.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Task.php",
    "method": "postTask",
    "line": 342
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "task",
    "short": "task",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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."
  }
}
Cookies & Datenschutz
Notwendig

Für Sicherheit, Navigation, Formulare und den technischen Betrieb der Website.

Immer aktiv
Datenschutzerklärung