...
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 |
| did | The document id. This must be a document within the scope. | Mandatory |
| locale | Language of the file. | Mandatory |
| folder | Folder ID of the file. If not specified then the call refers to the original file or deliverable (depending on the language). | Optional |
| name | Name the file. If not specified. If not specified then the call refers to the original file or deliverable (depending on the language). | Optional |
Note: To download the original file it is sufficient to specify "did" and to set "locale" to the source language. To download a deliverable it is sufficient to specify "did" and to set "locale" to a target language.
Download source file or deliverable
You do need to specify the "folder" and "name" parameters. Drop the two parameters and the download is for source/target file depending on the "locale".
The "folder" and "name" parameters for source/target files can of course be obtained from resources/files/get
Download attachments
You do need to specify the "folder" and "name" parameters. Drop the two parameters and the download is for source/target file depending on the "locale".
Use resources/files/get to get all files and folders including attachments related to document "did".
RESULTS
Returns an HTTP response with the file included as an attachment.
...