Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Laden Sie eine neue Datei in die Dateiablage hoch.

Beschreibung

Status
colourBlue
titlePOST
   /file_storage/upload_file.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&path=PATH

Parameter

Query-Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
pathZiel-Pfadstring

Format: Ordner,Unterorder,...,Zielordner (komma-getrennt)

Wurzelverzeichnis muss nicht mit angegeben werden.

Wenn nicht angegeben, wird die Datei in das Wurzelverzeichnis geladen. 

nein

Body-Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

fileDateifile

Sie 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"
    }

]


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.

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.

Sv translation
languageen

Upload a new file to file storage.

Description

Status
colourBlue
titlePOST
   /file_storage/upload_file.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&path=PATH

Parameters

Query parameters

parameter

description

type

hint

mandatory

companyRTI company keystring
yes
importRTI import keystring
yes
filenew filefile

The following file types are currently allowed:

  • PNG
  • JPG
  • GIF
  • MS Word
  • MS Excel
  • PDF

You can only upload one file per request. The maximum file size is 2 MB.

yes
pathtarget pathstring

Format: folder,subfolder,...,target folder (comma-separated)

Root does not have not specified in path.

If not set, file will be uploaded to root.

no

Body parameters

parameter

description

type

hint

mandatory

filenew filefile

The following file types are currently allowed:

  • PNG
  • JPG
  • GIF
  • MS Word
  • MS Excel
  • PDF

You can only upload one file per request. The maximum file size is 2 MB.

yes

return

If there are errors in the configuration of parameters, you will receive  "ERROR:description". If the upload was started, you will receive the result as JSON.

return example

[
    {
      "name": "file.png",
      "status": "OK",
      "uuid":"08910afd0bfcc7aa193d40c486ca156a"
    }

]

On successful upload you will receive the status "OK" and the UUID for the new file. On error you will get the corresponding error message and the UUID will be empty.

You can use the UUID as reference for file_storage/modify_file.php or to attach files via do_order resp. do_message.