File resource

Share file API - Add file for quick share

OVERVIEW

Purpose


This api method is used for uploading a file to a shared location. This method is different to "Add file" method in that the location to which the file is uploaded is not visible in the web based interface or accessible through the "Add file" API method. These files are considered temporary files and their existence depends on the share in which these files are used. The shared file is removed if there is no share referencing the file or all shares referencing the file have expired. 

Request URL

POST  /shares/content

Parameters
 

Parameter Name Type Description
progressiveoperkey={key}
(Optional)
query  Key used to determine the progress of the upload in case of a large file upload
filename={filename} 
this is form type parameter.
(mandatory parameter)
form used to specify the name of the file being uploaded. 

The method should always be used in conjunction with the share file method, otherwise the uploaded file is deleted after 5 days if no share references this file. 

Response format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<file>
    <fileid>12</fileid>
</file>

Response Codes

 

Code Meaning
201 document uploaded  successfully
401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occured while uploading document
 

Comments


2 Comments

Last Updated: Nov 08,2024