Wiki-Quellcode von file_storage/upload_file.php
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | (((Inhaltsverzeichnis))) | ||
3 | {{toc/}} | ||
4 | |||
5 | Laden Sie eine neue Datei in die Dateiablage hoch. | ||
6 | = Beschreibung = | ||
7 | **(% class="blue mark" %)POST(%%) **//** /file_storage/upload_file.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY**&path**=PATH// | ||
8 | = Parameter = | ||
9 | === Query-Parameter === | ||
10 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
11 | |company|RTI Firmenschlüssel|string||ja | ||
12 | |import|RTI Importschlüssel|string||ja | ||
13 | |path|Ziel-Pfad|string|Format: Ordner/Unterordner/.../Zielordner (durch / getrennt) | ||
14 | Wurzelverzeichnis muss nicht mit angegeben werden. Pfadangaben sind case-insensitive. | ||
15 | Wenn nicht angegeben, wird die Datei in das Wurzelverzeichnis geladen.|nein | ||
16 | |check_duplicates||string|Dieses Flag entscheidet ob eine Duplikatsprüfung vor dem Upload durchgeführt werden soll. Kann die Werte true/false annehmen. Wenn aktiviert und ein Duplikat festgestellt wird, so erhalten Sie als Status (siehe Rückgabe) 'File recognized as duplicate'. Die Datei wird nicht erneut hochgeladen und Sie erhalten als UUID den Wert des bereits in Ihrer Dateiablage vorhandenen Duplikats. Die Prüfung erfolgt über die gesamte Dateiablage hinweg, nicht nur im angegebenen Pfad. | ||
17 | Ist standardmäßig auf true gesetzt.|nein | ||
18 | |||
19 | **Achtung**: Die maximale Dateigröße für einen Upload beträgt 1,5 MB. | ||
20 | === Body-Parameter === | ||
21 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
22 | |file|Datei|file|Sie können aktuell die folgenden Dateitypen anhängen: | ||
23 | ((( | ||
24 | * PNG | ||
25 | * JPG | ||
26 | * GIF | ||
27 | * MS Word | ||
28 | * MS Excel | ||
29 | |||
30 | ))) | ||
31 | Sie können nur eine Datei pro Anfrage hochladen. Die maximale Dateigröße beträgt 2MB.|ja | ||
32 | |||
33 | = Rückgabe = | ||
34 | Liegen Fehler in der Konfiguration der Parameter vor, erhalten Sie "(% class="error" %)**ERROR:Beschreibung**(%%)" zurück. Wurde der Hochlade-Vorgang gestartet, erhalten Sie das Ergebnis als JSON. | ||
35 | **Rückgabebeispiel** | ||
36 | {{code language="java"}}[ | ||
37 | { | ||
38 | "name": "file.png", | ||
39 | "status": "OK", | ||
40 | "uuid":"08910afd0bfcc7aa193d40c486ca156a", | ||
41 | "checksums": { | ||
42 | "sha1": "a8ae815ac51f2f8d5520a1ed07d9d991fda45759" | ||
43 | } | ||
44 | } | ||
45 | ]{{/code}} | ||
46 | |||
47 | Die UUID können Sie zur Referenz für die Funktion [[file_storage/modify_file.php>>doc:YellowFox Remote Tracking Interface.Funktionen.Dateiablage.file_storagemodify_file\.php.WebHome]] nutzen oder um Anhänge über [[do_order>>doc:YellowFox Remote Tracking Interface.Funktionen.Aufträge und Nachrichten.do_order\.php.WebHome]] oder [[do_message>>doc:YellowFox Remote Tracking Interface.Funktionen.Aufträge und Nachrichten.do_message\.php.WebHome]] anzuhängen. | ||
48 | Bei erfolgreichem Hochladen erhalten Sie als Status 'OK' und die neu hinterlegte UUID für diese Datei. Im Fehlerfall erhalten Sie den entsprechenden Status und die UUID bleibt leer. | ||
49 |