Zum Inhalt springen
Developer

CronTask

Einstellungen / CronTask

System und Einstellungen4 EndpunkteSettings / CronTask

Liefert eine Liste aller CronTasks-Objekte.

GET/api/settings/cron_tasks

Query-Parameter

idstring
namestring
commandstring
runningboolean
doneboolean
deleteAfterDoneboolean
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste aller CronTasks-Objekte.array<CronTask>

Felder anzeigen (9)
  • namestring

    Name des Cron-Tasks.

  • commandstring

    Befehl, den die Cron-Aufgabe ausführt.

  • resultstring

    Ergebnis des letzten Laufs.

  • interval_lengthstring

    Intervall zwischen zwei Läufen.

  • last_runstring (date-time)

    Zeitpunkt des letzten Laufs.

  • next_runstring (date-time)

    Zeitpunkt des nächsten Laufs.

  • runningboolean

    Ob die Aufgabe gerade läuft.

  • doneboolean

    Ob die Aufgabe erledigt ist.

  • delete_after_doneboolean

    Ob die Aufgabe nach Erledigung gelöscht wird.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/settings/cron_tasks \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "name": "Beispiel",
    "command": "string",
    "result": "string",
    "interval_length": "string",
    "last_run": "2026-10-15T09:30:00+02:00",
    "next_run": "2026-10-15T09:30:00+02:00",
    "running": true,
    "done": true,
    "delete_after_done": true
  }
]

CronTask neu anlegen

POST/api/settings/cron_tasks

Request-Body application/json

  • dataCronTask
    Felder anzeigen (9)
    • namestring

      Name des Cron-Tasks.

    • commandstring

      Befehl, den die Cron-Aufgabe ausführt.

    • resultstring

      Ergebnis des letzten Laufs.

    • interval_lengthstring

      Intervall zwischen zwei Läufen.

    • last_runstring (date-time)

      Zeitpunkt des letzten Laufs.

    • next_runstring (date-time)

      Zeitpunkt des nächsten Laufs.

    • runningboolean

      Ob die Aufgabe gerade läuft.

    • doneboolean

      Ob die Aufgabe erledigt ist.

    • delete_after_doneboolean

      Ob die Aufgabe nach Erledigung gelöscht wird.

Antworten

200CronTask neu anlegenCronTask

Felder anzeigen (9)
  • namestring

    Name des Cron-Tasks.

  • commandstring

    Befehl, den die Cron-Aufgabe ausführt.

  • resultstring

    Ergebnis des letzten Laufs.

  • interval_lengthstring

    Intervall zwischen zwei Läufen.

  • last_runstring (date-time)

    Zeitpunkt des letzten Laufs.

  • next_runstring (date-time)

    Zeitpunkt des nächsten Laufs.

  • runningboolean

    Ob die Aufgabe gerade läuft.

  • doneboolean

    Ob die Aufgabe erledigt ist.

  • delete_after_doneboolean

    Ob die Aufgabe nach Erledigung gelöscht wird.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/settings/cron_tasks \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "command": "string",
    "result": "string",
    "interval_length": "string",
    "last_run": "2026-10-15T09:30:00+02:00",
    "next_run": "2026-10-15T09:30:00+02:00"
  }
}
'
Antwort 200 application/json
{
  "name": "Beispiel",
  "command": "string",
  "result": "string",
  "interval_length": "string",
  "last_run": "2026-10-15T09:30:00+02:00",
  "next_run": "2026-10-15T09:30:00+02:00",
  "running": true,
  "done": true,
  "delete_after_done": true
}

Liefert einen einzelnen CronTask-Eintrag.

GET/api/settings/cron_tasks/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes CronTask-Objekt zurück.CronTask

Felder anzeigen (9)
  • namestring

    Name des Cron-Tasks.

  • commandstring

    Befehl, den die Cron-Aufgabe ausführt.

  • resultstring

    Ergebnis des letzten Laufs.

  • interval_lengthstring

    Intervall zwischen zwei Läufen.

  • last_runstring (date-time)

    Zeitpunkt des letzten Laufs.

  • next_runstring (date-time)

    Zeitpunkt des nächsten Laufs.

  • runningboolean

    Ob die Aufgabe gerade läuft.

  • doneboolean

    Ob die Aufgabe erledigt ist.

  • delete_after_doneboolean

    Ob die Aufgabe nach Erledigung gelöscht wird.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/settings/cron_tasks/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "name": "Beispiel",
  "command": "string",
  "result": "string",
  "interval_length": "string",
  "last_run": "2026-10-15T09:30:00+02:00",
  "next_run": "2026-10-15T09:30:00+02:00",
  "running": true,
  "done": true,
  "delete_after_done": true
}

Einen CronTask löschen

DELETE/api/settings/cron_tasks/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

default

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/settings/cron_tasks/42 \
  --header 'x-iw-jwt-token: <TOKEN>'