Austrittspaket

vm_erp.vm_erp.export.api.austritt_herunterladen

• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

Gibt die private Datei-URL des fertigen Archivs zurueck und vermerkt den Abruf im Protokoll.

Rollen: Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Felder der Antwort (message): dateiname, file_url

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"job_id": "<JOB_ID>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.export.api.austritt_herunterladen"

{"message": ...}

vm_erp.vm_erp.export.api.austritt_starten

• POST
• Schreibend, rollengeschützt
• Fehlernummer bei unerwarteten Fehlern

Startet den Export im Hintergrund (queue long). Gibt {job_id} zurueck.

Rollen: Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

Felder der Antwort (message): job_id

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"company": "<COMPANY>", "date_from": "<DATE_FROM>", "date_to": "<DATE_TO>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.export.api.austritt_starten"

{"message": ...}

vm_erp.vm_erp.export.api.austritt_status

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Fortschritt eines Exports. Nur lesend; nur der Nutzer, der ihn gestartet hat (und nur als System Manager).

Rollen: Systemverwalter.

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "job_id=<JOB_ID>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.export.api.austritt_status"

{"message": ...}