Folder resource

Get folder path

OVERVIEW


 

API method to get folder details along with its parent folder hierarchy and the information from Collaborate.

 

Resource(API) EndPoint Query Params HTTP Method Request XML Response  Response Code
/folders/{folderId}/path  - GET    Response XML Response Code

 

Response

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

 

Parameter Name

Value

Description

folderid

Int

ID of the parent folder in which the folder exists

folderName

String

Name of the parent folder

noOfDocs

int

No. of documents in folder

name

String

 Name of folder

permission

Object

Permission object for folder

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

SiteId

int

ID of site in which folder exists

location

String

String showing hierarchy of parent folders

location

String

Full path to the file location in Collaborate including site name

createdby

Object

User object for the person who created this file

modifiedby

Object

User object for the person who modified this file

 

 

Response XML

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



<folder>

  <folder>

    <folderId>6059</folderId>

    <folderName>test_folder</folderName>

    <noOfDocs>6</noOfDocs>

    <folder>

      <folderId>10114</folderId>

      <folderName>A</folderName>

      <noOfDocs>0</noOfDocs>

      <folder>

        <folderId>10115</folderId>

        <folderName>B</folderName>

        <noOfDocs>0</noOfDocs>

        <folder>

          <folderId>10116</folderId>

          <folderName>C</folderName>

          <noOfDocs>6</noOfDocs>

          <folder>

            <folderId>10119</folderId>

            <folderName>y</folderName>

            <noOfDocs>0</noOfDocs>

          </folder>

        </folder>

      </folder>

    </folder>

  </folder>

  <id>10119</id>

  <name>y</name>

  <permission>

    <view>1</view>

    <edit>1</edit>

    <delete>1</delete>

    <addEditAllFiles>1</addEditAllFiles>

    <viewAllFiles>1</viewAllFiles>

    <admin>1</admin>

  </permission>

  <siteid>4008</siteid>

  <accessInherited>1</accessInherited>

  <createddate>09 Aug 2018 12:56</createddate>

  <modifieddate>09 Aug 2018 12:56</modifieddate>

  <location>test_folder &gt; A &gt; B &gt; C</location>

  <createdby>

    <firstname>Tom</firstname>

    <lastname>Chick</lastname>

    <email>tom.chick@highq.com</email>

    <userid>102</userid>

  </createdby>

  <modifiedby>

    <firstname>Tom</firstname>

    <lastname>Chick</lastname>

    <email>tom.chick@highq.com</email>

    <userid>102</userid>

  </modifiedby>

  <contentstatus>1</contentstatus>

</folder>

 

Response Error Code :

 

Code Meaning
401 Unauthorised
403 Validation failed/ Forbidden
405 Method not allowed (calling API with wrong method)
500 Internal error

 

 

Comments


0 Comments

Last Updated: Jun 09,2023