Beispieldaten

vm_erp.vm_erp.beispieldaten.api.entfernen

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

Entfernt alles, was dieser Lauf angelegt hat und noch den Marker traegt. Verlangt das Tippen des Profilnamens.

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

Felder der Antwort (message): entfernt, ok, uebersprungen

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"lauf": "<LAUF>", "bestaetigung": "<BESTAETIGUNG>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.beispieldaten.api.entfernen"

{"message": ...}

vm_erp.vm_erp.beispieldaten.api.laden

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

Legt das Profil an (nur was fehlt). Bei einem Fehler wird abgebrochen; was bis dahin entstand, steht im Laufdatensatz und laesst sich mit entfernen zurueckbauen.

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

Felder der Antwort (message): angelegt, hinweis, ok

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

{"message": ...}

vm_erp.vm_erp.beispieldaten.api.laeufe

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Rollen: Systemverwalter.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.beispieldaten.api.laeufe"

{"message": ...}

vm_erp.vm_erp.beispieldaten.api.profile

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Die Profile mit Titel, Beschreibung und der Menge, die ein Laden anlegen wuerde.

Rollen: Systemverwalter.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.beispieldaten.api.profile"

{"message": ...}

vm_erp.vm_erp.beispieldaten.api.vorschau

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Rollen: Systemverwalter.

Felder der Antwort (message): menge, profil, schritte

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "profil=<PROFIL>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.beispieldaten.api.vorschau"

{"message": ...}