Wiki

Case Status Kiln
Log In

Wiki

 
Retrieve folder contents
  • RSS Feed

Last modified on 19/10/2016 5:53 AM by User.

Tags:

Retrieve folder contents

Context  
        User wants to get folder contents
       URL
          https://api.intelligencebank.com/webapp/1.0/resources
       Method
        GET
       
    Parameters
        p10: {client api key}
        p20: {user uuid}
        OPTIONAL -> folderuuid: folderuuid | folderlist: comma separated list of folderuuids
               
    Header:
        _aid: <session id>
 
    Response
        200 : OK
            <response>
                <hasversions>{1 | 0}</hasversions>
                <folder>
                    <folderuuid>{folder uuid}</folderuuid>
                    <name>{folder name}</name>
                    <description>{folder description}</description>
                    <createdtime>{folder created datetime}</createdtime>
                    <comments>{ 1 | null }</comments>
                    <children>
                        <folders>{count of sub folders}</folders>
                        <resources>{count of child resources}</resources>
                    </children>
                </folder>
                <resource>
                    <resourceuuid>{resource uuid}</resourceuuid>
                    <seen>{1 | 0}</seen>
                    <title>{resource title}</title>
                    <description>{resource description}</description>
                    <updatedat>{ last update date of file }</updatedat>
                    <processedat>{ last process date of file }</processedat>
                    <updatedby>{last updated by}</updatedby>
                    <tags>{resource tags}</tags>
                    <fileuuid>{resource uuid}</fileuuid>
                    <filetype>{info about file type}</filetype>
                    <origfilename>{original filename for display}</origfilename>
                    <resourcedate>{created date}</resourcedate>
                    <uploadedtime>{created time}</uploadedtime>
                    <printing>{ 1 | null}</printing>
                    <version>{current version number}</version>
                    <versions>{list of versions for resource}</versions>
                </resource>
            </response>
        500 : Internal server error

   Actions
        Display the contents of the folder
        
   Notes:
    1. If the folderuuid is absent then the contents of the root folder are returned.
    2. The 'seen' field indicates if the user has viewed this resource before
    3. The versions field list only shows if 'hasversions' is set to 1
    4. The updatedat field will change if anything gets updated e.g. description, file. So if versions
        are not enabled or are notmandatory and turned off for a file updated, then in order to know
          whether the file has been updated and needs to be downloaded again, compare the processedat fields. This field
        only changes when the file gets replaced.