You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Upload a new file to file storage.

Description

POST   /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 (separated by /)

Root does not have to be 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.

  • No labels