resources/files/upload

Saves a file as deliverable or as an attachment.

The file is passed as a secure file reference token.

URL

(POST) /resources/files/upload

PARAMETERS

The message body contains a JSON object:

scope

The scope object. Note that if you use a document set or global search scope, you will receive an "available" = false result. In fact these scopes do not support files.

Mandatory
didThe document id. This must be a document within the scope.Mandatory
tokenThe secure reference file token. A previous upload mechanism gives you this token.Mandatory
locale

To which language this file shall be uploaded.

Mandatory
   
folder

Save file to the existing folder ID.

If null then the system assumes that you want to upload a deliverable (and not an attachment).

Optional
name

Save with this (optional) name.

If you do not provide this parameter, the system uses the name of the uploaded file (see "token" parameter).

NOTE: Always specify "name" when uploading deliverables. Users expect that the name of a deliverable is identical to the name of the source file. It is even better to first obtain the current name of the deliverable and show to the user with the option to edit the name.

Optional
overwriteOptional. By default is false.Optional
returnChangesOptional. By default is true. Tells if the method shall return the full file information or just null (faster).Optional

 

RESULTS

If returnChanges is true, then the method returns the same JSON as specified in:

resources/files/get

 

 

 

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008