File resource

Get file info - Get file info v1

OVERVIEW

Note: The latest specification for Collaborate 4.1.4 and above is here 

Get a file’s basic metadata information as listed below given the file ID. Please note this call does not provide you with the file metadata iSheet information. 

Request

GET       /api/1/files/{fileid}

Parameters
 

Parameter Name Value Description
fileid Int The ID for the file in question
lastdmsinfo (This is a query string parameter) true/false This parameter is supported from Collaborate version 3.4.5. Default is false. Setting this parameter returns the last added DMS version with a given Collaborate version of the document. 

 

 

Request body

Do not supply a request body with this method.

Response

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

Parameter Name Value Description
folderid Int The id of the folder in which the file exists
id Int The ID for the file in question
name String Name of the file
versionid Int Collaborate file version
versionnote String Any version notes provided for the file
createddate Date Date is provided in “dd mmm yyyy” format based on UTC timezone
modifieddate Date

Date is provided in “dd mmm yyyy” format based on UTC timezone.

Author, creation and modified date is provided based on site settings
type String Information stating the type of file
icon String URL to the file icon, this will bypass the security so that the API end user can obtain the file icon if required. (API endpoint for file icon will be provided in future releases)
originaltype String The original type of the file before conversion ( if any ). Originaltype will be shown 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)
size int size in bytes. "size" is based on show size configuration at site level, "size" is in Bytes
commentscount Int Number of comments for the file
likescount Int No of likes for the file. Likes should be enabled for the instance and the user should not be a bidder user, otherwise the returned value will be 0
tags String Tags for the file
location String Full path to the file location in Collaborate including site name
dms Object Detailed related to the DMS from where the file was added.
createdby Object User object for the person who created this file
modifiedby Object User object for the person who modified this file

 

Example request:

GET http://clientinstance.highq.com/clientinstance/api/1/files/1234

Example response:

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

<file>
    <folderID>3075</folderID>
    <name>RRRRRRRRRR</name>
    <id>868</id>
    <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>http://clientinstance.highq.com/clientinstance/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>ankit</dmsdatabasename>
        <dmsversion>1</dmsversion>                                      <!-- support from 3.4.5 branch -->
    </dms>
    <createdby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>user@highq.com</email>
        <userid>103</userid>
    </createdby>
    <modifiedby>
        <firstname>Tom</firstname>
        <lastname>Chick</lastname>
        <email>user@highq.com</email>
        <userid>103</userid>
    </modifiedby>
</file>

 

Comments


2 Comments


Fernando Deleon please use the lastdmsinfo parameter as suggested in this documentation to get the DMS info, if you are after the file metadata iSheet info then it cannot be obtained via this call.


Am I suppose to see the metadata info? when i make a call to retrieve a file info, i get all the file information but no DMS entry assuming thats where i will see the metadata information

my endpoint is ./api/1/files?q="folderid=xxx"

where xxx is the folder that contains the file

 

Last Updated: Nov 08,2024