Download File
OVERVIEW
This is the latest version of this API endpoint, for older versions please see the child pages of this page
Version 1
API method to download a single document ( document content not its metadata) from Collaborate. The method supports download by a specific document version. Admin users can download the original content of the document by passing downloadoriginal=true as query parameter.
Resource(API) EndPoint | Query Params | HTTP Method | Request XML | Response | Response Code |
---|---|---|---|---|---|
/files/{fileid}/content |
version={versionno} original=true/false(default)
|
GET | Binary stream of document | Response Code |
- original=true parameter is only applicable for users, who have rights to download original version from UI.
- If workflow is enabled & document is in pending state then the document should only download file to file owner & content admin.
Version 2
API method to download a single document ( document content not its metadata) from Collaborate. The method supports downloading document by a specific version. Admin users can download the encrypted content of the document by passing "getconvertedfile=true" as query parameter. If the "getconvertedfile" parameter is not passed then users, who have rights to download original version from Collaborate interface will receive the original document others will get encrypted document.
Resource(API) EndPoint | Query Params | HTTP Method | Request XML | Response | Response Code |
---|---|---|---|---|---|
/files/{fileid}/content |
version={versionno} getconvertedfile=true/false(default)
|
GET | Binary stream of document | Response Code |
- getconvertedfile=true parameter is used to get encrypted document.
- If workflow is enabled & document is in pending state then the document should only download file to file owner & content admin.
- Users, who have rights to download original version from the Collaborate interface will receive the original document others will get encrypted document.
Response Code
Code | Meaning |
---|---|
200 | Document found |
400 | Problem with parsing XML or JSON object (Bad Request) |
401 | Unauthorized |
403 | Validation failed/ Forbidden |
404 | Document doesn't exists in the system |
405 | Method not allowed (calling api with wrong method) |
500 | Internal error occured while gettting document content |
Comments
0 Comments