Folders

SAClient.search_folders(project, folder_name=None, status=None, return_metadata=False)

Folder name based case-insensitive search for folders in project.

Parameters:

• project (str) – project name

• folder_name (str. If None, all the folders in the project will be returned.) – the new folder’s name

• status (str or list of str) –

  search folders via status. If None, all folders will be returned.

  Available statuses are:

  * NotStarted
  * InProgress
  * Completed
  * OnHold
  

• return_metadata (bool) – return metadata of folders instead of names

Returns:

folder names or metadatas

Return type:

list of strs or dicts

SAClient.set_folder_status(project, folder, status)

Set folder status

Parameters:

• project (str) – project name

• folder (str) – folder name

• status (str) –

  status to set.

  Available statuses are:

  * NotStarted
  * InProgress
  * Completed
  * OnHold
  

SAClient.assign_folder(project_name, folder_name, users)

Assigns folder to users. With SDK, the user can be assigned to a role in the project with the share_project function.

Parameters:

• project_name (str or dict) – project name or metadata of the project

• folder_name (str) – folder name to assign

• users (list of str) – list of user emails

SAClient.unassign_folder(project_name, folder_name)

Removes assignment of given folder for all assignees. With SDK, the user can be assigned to a role in the project with the share_project function.

Parameters:

• project_name (str) – project name

• folder_name (str) – folder name to remove assignees

SAClient.get_folder_by_id(project_id, folder_id)

Returns the folder metadata

Parameters:

• project_id (int) – the id of the project

• folder_id (int) – the id of the folder

Returns:

folder metadata

Return type:

dict

SAClient.get_folder_metadata(project, folder_name)

Returns folder metadata

Parameters:

• project (str) – project name

• folder_name (str) – folder’s name

Returns:

metadata of folder

Return type:

dict

SAClient.create_folder(project, folder_name)

Create a new folder in the project.

Parameters:

• project (str) – project name

• folder_name (str) – the new folder’s name

Returns:

dict object metadata the new folder

Return type:

dict

SAClient.delete_folders(project, folder_names)

Delete folder in project.

Parameters:

• project (str) – project name

• folder_names (list of strs) – to be deleted folders’ names