MaintenanceCommand

Einstellungen / MaintenanceCommand

System und Einstellungen2 EndpunkteSettings / MaintenanceCommand

Liefert die Wartungsbefehle, die über die Oberfläche gestartet werden können, einschließlich der Optionen, die jeder Befehl akzeptiert.

GET/api/settings/maintenance_commands

Antworten

200Liefert alle verfügbaren Wartungsbefehle.object

Felder anzeigen (2)

successboolean
dataarray<object>
Felder anzeigen (6)
- keystring
- labelstring
- descriptionstring
- sectionstring
- applyOptionstring
- optionsarray<object>

Anfrage

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

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/settings/maintenance_commands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/settings/maintenance_commands', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/settings/maintenance_commands")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/maintenance_command_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MaintenanceCommandController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "success": true,
  "data": [
    {
      "description": "Text",
      "key": "string",
      "label": "string",
      "section": "string",
      "applyOption": "string"
    }
  ]
}

Stellt einen Wartungsbefehl als CronTask in die Warteschlange und gibt diesen Task zurück. Die Befehlsausgabe erscheint im Ergebnis des Tasks, sobald der Cron ihn ausgeführt hat.

POST/api/settings/maintenance_commands

Request-Body application/json

keystring
Befehlsschlüssel aus dem Listen-Endpunkt
optionsobject
Option Name => Wert, validiert gegen die Befehlsdefinition

Antworten

200Der eingereihte CronTaskCronTask

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/maintenance_commands \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"key":"string"}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({key: 'string'})
};

fetch('https://eure-instanz.iw-erp.de/api/settings/maintenance_commands', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"

payload = { "key": "string" }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/settings/maintenance_commands', [
  'body' => '{"key":"string"}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"key\":\"string\"}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"key\":\"string\"}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/settings/maintenance_commands")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/settings/maintenance_commands"

	payload := strings.NewReader("{\"key\":\"string\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/maintenance_command_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await MaintenanceCommandController.run('…');
if (result.success) {
  print(result.data);
}

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
}