Folder resource

Get folder info - Get folder Info v1

OVERVIEW

This is the first version of this API which was changed in Collaborate 4.0 and above

Get a folder’s metadata by folder ID.

Request

GET       /api/1/folders/{folderid}

Parameters

Parameter Name

Value

Description

folderid

Int

The ID for the folder in question

 

Request body

Do not supply a request body with this method.

Response

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

Example Request

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

Example Response

XML:

<?xml version="1.0" encoding="UTF-8"?>
<folder>
   <id>20</id>
   <name>test-2copyfileandfolder</name>
   <description>This is discption for Demofolder</description>
   <parentFolderID>0</parentFolderID>
   <createddate>12 Sep 2014 11:26</createddate>
   <modifieddate>11 Nov 2014 12:24</modifieddate>

   <location>Deleted Items</location>                      <!-- (supported from 3.4.4 branch)  -->


  <!-- optional DMS settings -->

  <dms>
             <dmsfolderid>folder id of the item stored in Collaborate</dmsfolderid>
            <dmsParentFolderID> parent folder id of this item</dmsParentFolderID>
           <dmscreateddate>date when the folder was created</dmscreateddate>
           <dmsmodifiedBy>the id of the person making the modification</dmsmodifiedBy>
            <dmsdatabasename>name of the external database</dmsdatabasename>

   </dms>

   <createdby>
      <firstname>firstname</firstname>
      <lastname>lastname</lastname>
      <email>firstname.lastname@highq.com</email>
      <userid>11</userid>
   </createdby>
   <modifiedby>
      <firstname>firstname</firstname>
      <lastname>lastname</lastname>
      <email>firstname.lastname@highq.com</email>
      <userid>11</userid>
   </modifiedby>
</folder>

JSON:

{
   "name": "test-2copyfileandfolder",
   "description": "This is discption for Demofolder",
   "parentFolderID": 0,
   "accessInherited": null,
   "batchID": null,
   "dms": null,
   "id": 20,
   "link": null,
   "createddate": "12 Sep 2014 11:26",
   "modifieddate": "11 Nov 2014 12:24",
   "permission": null,
   "child": null,
   "createdby": {
      "firstname": "firstname",
      "lastname": "lastname",
      "email": "firstname.lastname@highq.com",
      "userid": 11
   },
   "modifiedby": {
      "firstname": "firstname",
      "lastname": "lastname",
      "email": "firstname.lastname@highq.com",
      "userid": 11
   }
}

Comments


0 Comments

Last Updated: Jun 09,2023