Get file info

This is the latest version of this API endpoint valid from Collaborate 4.1.4 and above, for older versions please see the child pages of this page

Get a file’s metadata given the file ID.

Request

GET       /api/1/files/{fileid}

Parameters
 

Request body

Do not supply a request body with this method.

Response

If successful this method returns a file resource in the response body.
 

Response XML

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<file>
    <folderID>3075</folderID>
    <name>RRRRRRRRRR</name>
    <id>868</id>
    <siteid>2</siteid>                                                <!-- Supported from 4.0.3 branch -->
    <versionid>1</versionid>
    <versionnote></versionnote>
    <createddate>20 Jun 2014 10:06</createddate>
    <modifieddate>20 Jun 2014 10:06</modifieddate>
    <type>pdf</type>
    <originaltype>txt</originaltype>
    <size>13878</size>
    <icon>https://domain.com/instancename/images/fileicon/pdf.png</icon>
    <commentscount>0</commentscount>
    <likescount>0</likescount>
     <tags>
        <tag>asdf</tag>
        <tag>asfn</tag>
    </tags>
    <location>Deleted Items</location>
    <dms>
        <dmsdocid>23</dmsdocid>
        <dmsParentFolderID>55</dmsParentFolderID>
        <dmscreateddate>2014-06-20T10:06:14.770+05:30</dmscreateddate>
        <dmsmodifiedBy>103</dmsmodifiedBy>
        <dmsdatabasename>user</dmsdatabasename>
        <dmsversion>1</dmsversion>                                  <!-- support from 3.4.5 branch -->
    </dms>
    <createdby>
        <firstname>firstname</firstname>
        <lastname>lastname</lastname>
        <email>first.last@highq.com</email>
        <userid>103</userid>
    </createdby>
    <modifiedby>
        <firstname>first</firstname>
        <lastname>last</lastname>
        <email>first.last@highq.com</email>
        <userid>103</userid>
    </modifiedby>    <contentstaus>0</contentstatus> <!-- (Tag has been added in 4.1.3 ) -->
    <permission>
        <view>1</view>
        <edit>1</edit>                                               <!-- support from 4.0.3 branch -->
        <delete>1</delete>
    </permission>

</file>

1. "originaltype" field will hold a value when site level configuration for Enable automatic PDF conversion = true or Online viewer with DRM = true or Convert all files to PDF and encrypt with FileOpen plugin = true or (Encrypt PDF files with FileOpen plugin = true and file is PDF)
2. "size" field is populated depending on the "show size" configuration at site level, "size" is in Bytes. If this configuration is set to false, no size information will be provided through the API. 
3. Query params 'lastdmsinfo' is support from Collaborate 3.4.5 branch. It accepts  true/false value. By default false. If this value is set as true then response will have last added dms version <dms> information. Current file version does not have bounded <dms> information.
4. The siteID and permission fields have been added to the response from Collaborate 4.0.3