Update file
Update file
OVERVIEW
This API method updates the details of an existing file.
Request
PUT /api/1/files/{fileid}
Parameters
| Parameter Name | Value | Description |
|---|---|---|
| fileid | Int | The ID for the file in question |
Request body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<file>
<filename>newDoc</filename> (This is an optional tag)
<dmsVersion>{dms version of the file}</dmsVersion> (Please make sure that you use the correct case for the tag as the tags are case sensative)
<versionid>{Collaborate version of the file}</versionid>
<!-- optional parameters -->
<dms>
<dmsdocid>{Change to the dms document ID}</dmsdocid>
<dmseditdate>{Date the document was edited / updated in the DMS system}</dmseditdate> (The format for date is yyyy-MM-dd HH:mm:ss )
<dmsParentFolderID>{Parent folder id of the document in the DMS system}</dmsParentFolderID>
<dmsdatabasename>{Name of the DMS database}</dmsdatabasename>
</dms>
</file>
| Parameter Name | Value | Description |
|---|---|---|
| filename | string | Name of file, which is to be updated in the system |
The dms parameters are optional, and will be updated only when the details are provide in the request body. Please refer to Add file API for the details of each dms parameter.
Please use Content-Type = application/xml in the header parameters for the API call to work.
Response
If successful this method returns a 200 OK response.
Thank you
Your review has been submitted.
Comments
0 Comments