file_storage/upload_file.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Laden Sie eine neue Datei in die Dateiablage hoch.

Beschreibung

POST   /file_storage/upload_file.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&path=PATH

Parameter

Query-Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstringja
importRTI Importschlüsselstringja
pathZiel-PfadstringFormat: Ordner/Unterordner/.../Zielordner (durch / getrennt)
Wurzelverzeichnis muss nicht mit angegeben werden. Pfadangaben sind case-insensitive.
Wenn nicht angegeben, wird die Datei in das Wurzelverzeichnis geladen.
nein
check_duplicatesstringDieses 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.
Ist standardmäßig auf true gesetzt.
nein

Achtung: Die maximale Dateigröße für einen Upload beträgt 1,5 MB.

Body-Parameter

ParameterBeschreibungTypHinweisPflicht
fileDateifileSie können aktuell die folgenden Dateitypen anhängen:
  • PNG
  • JPG
  • GIF
  • MS Word
  • MS Excel
  • PDF
Sie können nur eine Datei pro Anfrage hochladen. Die maximale Dateigröße beträgt 2MB.
ja

Rückgabe

Liegen Fehler in der Konfiguration der Parameter vor, erhalten Sie "ERROR:Beschreibung" zurück. Wurde der Hochlade-Vorgang gestartet, erhalten Sie das Ergebnis als JSON.
Rückgabebeispiel
[
    {
      "name": "file.png",
      "status": "OK",
      "uuid":"08910afd0bfcc7aa193d40c486ca156a",
 "checksums": {
"sha1": "a8ae815ac51f2f8d5520a1ed07d9d991fda45759"
 }
    }
]

Die UUID können Sie zur Referenz für die Funktion file_storage/modify_file.php  nutzen oder um Anhänge über do_order oder do_message anzuhängen.
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.