Inhalt der Dokumentation

Datenimport

CSV-Dateien einlesen, zuordnen, prüfen und übernehmen.

3 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

importieren
vorschau
ziele

`vm_erp.vm_erp.import_assistent.api.importieren`

GET
POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Importiert nur, wenn der Probelauf ohne Fehler ist. Zeilen mit vorhandenem Schluessel werden uebersprungen.

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

Parameter	Typ	Pflicht
`ziel`	string	ja
`inhalt`	string	ja
`zuordnung`	string	nein

Felder der Antwort (message): angelegt, probleme, uebersprungen

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "ziel=<ZIEL>" \
  --data-urlencode "inhalt=<INHALT>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.import_assistent.api.importieren"

{"message": ...}

`vm_erp.vm_erp.import_assistent.api.vorschau`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Liest die Datei, schlaegt die Zuordnung vor und macht den Probelauf. Legt nichts an.

Rollen: Systemverwalter.

Parameter	Typ	Pflicht
`ziel`	string	ja
`inhalt`	string	ja
`zuordnung`	string	nein

Felder der Antwort (message): anzahl_fehler, anzahl_neu, anzahl_uebersprungen, beispiele, dubletten, fehlende_felder, fehler, gesamt, kodierung, leere_zeilen, ok, trennzeichen, uebersprungen, zuordnung

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "ziel=<ZIEL>" \
  --data-urlencode "inhalt=<INHALT>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.import_assistent.api.vorschau"

{"message": ...}

`vm_erp.vm_erp.import_assistent.api.ziele`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Importtypen mit ihren Feldern, fuer die Auswahl der Spalten.

Rollen: Systemverwalter.

Parameter: keine.

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

{"message": ...}