Get Folder Details

You can retrieve the details of the folders created in the Catalyst File Store. It can be a single folder or all the folders located in the File store.

To know more about the component instance filestore_service used below, please refer to this help section.

Get Details of a Single Folder

This particular method retrieves the details of a specific folder referred through its unique folder ID by calling the get_folder_details() method. You can obtain the folder ID from the Data Store or from the URL when the folder is opened in the console.

The folder meta details are returned as response to this method.

Parameters Used

    

        
copy
        

            

        
    
    

         #Get details of a single folder
filestore_service = app.filestore()
data = filestore_service.get_folder_details(5249000000016011)

    

A sample response is shown below :

    

        
copy
        

            

        
    
    

         {
   "folder_name":"Store_Data",
   "created_time":"Aug 13, 2021 05:32 PM",
   "created_by":{
      "zuid":"66466723",
      "is_confirmed":false,
      "email_id":"amelia.burrows@zylker.com",
      "first_name":"Amelia",
      "last_name":"Burrows",
      "user_type":"Admin",
      "user_id":"2136000000006003"
   },
   "modified_time":"Aug 13, 2021 05:32 PM",
   "modified_by":{
      "zuid":"66466723",
      "is_confirmed":false,
      "email_id":"amelia.burrows@zylker.com",
      "first_name":"Amelia",
      "last_name":"Burrows",
      "user_type":"Admin",
      "user_id":"2136000000006003"
   },
   "project_details":{
      "project_name":"ShipmentTracking",
      "id":"2136000000007733",
      "project_type":"Live"
   },
   "file_details":[
      {
         "id":"2136000000020111",
         "file_location":null,
         "file_name":"Img.jpeg",
         "file_size":"84881",
         "created_by":{
            "zuid":"66466723",
            "is_confirmed":false,
            "email_id":"p.boyle@zylker.com",
            "first_name":"Patricia",
            "last_name":"Boyle",
            "user_type":"Admin",
            "user_id":"2136000000006767"
         },
         "created_time":"Aug 17, 2021 09:32 PM",
         "modified_by":{
            "zuid":"66466723",
            "is_confirmed":false,
            "email_id":"p.boyle@zylker.com",
            "first_name":"Patricia",
            "last_name":"Boyle",
            "user_type":"Admin",
            "user_id":"2136000000006767"
         },
         "modified_time":"Aug 17, 2021 09:32 PM",
         "project_details":{
            "project_name":"ShipmentTracking",
            "id":"2136000000007733",
            "project_type":"Live"
         },
         "folder_details":"5249000000016011"
      }
   ],
   "id":"2136000000008551"
}

    

Get Details of All Folders

You can fetch the details of all folders in your Catalyst application using the get_all_folders() method.

An array of folder meta details is returned as response to this method.

    

        
copy
        

            

        
    
    

         #Get details of all folders
filestore_service = app.filestore()
data = filestore_service.get_all_folders()

    

A sample response is shown below :

    

        
copy
        

            

        
    
    

         [
   {
      "folder_name":"Invoices",
      "created_time":"Aug 25, 2021 11:38 AM",
      "created_by":{
         "zuid":"66466723",
         "is_confirmed":false,
         "email_id":"emma@zylker.com",
         "first_name":"Amelia",
         "last_name":"Burrows",
         "user_type":"Admin",
         "user_id":"2136000000006003"
      },
      "modified_time":"Aug 25, 2021 11:38 AM",
      "modified_by":{
         "zuid":"66466723",
         "is_confirmed":false,
         "email_id":"emma@zylker.com",
         "first_name":"Amelia",
         "last_name":"Burrows",
         "user_type":"Admin",
         "user_id":"2136000000006003"
      },
      "project_details":{
         "project_name":"ShipmentTracking",
         "id":"2136000000007733",
         "project_type":"Live"
      },
      "id":"2136000000037021"
   },
   {
      "folder_name":"Store_Data",
      "created_time":"Aug 13, 2021 05:32 PM",
      "created_by":{
         "zuid":"66466723",
         "is_confirmed":false,
         "email_id":"emma@zylker.com",
         "first_name":"Amelia",
         "last_name":"Burrows",
         "user_type":"Admin",
         "user_id":"2136000000006003"
      },
      "modified_time":"Aug 13, 2021 05:32 PM",
      "modified_by":{
         "zuid":"66466723",
         "is_confirmed":false,
         "email_id":"emma@zylker.com",
         "first_name":"Amelia",
         "last_name":"Burrows",
         "user_type":"Admin",
         "user_id":"2136000000006003"
      },
      "project_details":{
         "project_name":"ShipmentTracking",
         "id":"2136000000007733",
         "project_type":"Live"
      },
      "id":"2136000000008551"
   }
]