Folder Tree and Information

Fetch a Specific Folder

A client may need to get information about a specific folder in the repository. This may be done using the following functions depending on the information available:

get_folder_detail(session, folder_id) :kt_folder_detail
get_folder_detail_by_name(session, folder_name, parent_id) :kt_folder_detail
Field Type Description
sessionStringThe session token.
folder_idIntegerThe ID of the required folder.
folder_nameStringThe name of the folder or the folder path from a specific parent folder as supplied by the parent_id.
parent_idIntegerThe parent / containing folder. Provides a starting point for finding the folder so that the folder has a relative starting position. This may be set to 1, the root folder id, and a full path may then be used in the folder_name.

Response

A kt_folder_detail response object is returned.

Fetch the Folder Tree

get_folder_contents(session, folder_id, depth, what) :kt_folder_contents
Field Type Description
sessionStringThe session token.
folder_idIntegerThe ID of the required folder.
depthStringThe number of levels of structure to return. 1 will return a single level and -1 will return the entire structure.
whatStringDefines what item types should be returned: F = folders, D = documents, S = shortcuts. Set it to DFS for all items to be returned

Response

A kt_folder_contents response object is returned.