Folders

Create folder

To create a folder:

sa.create_folder(
    project = "Project Name",
    folder_name = "Folder Name")

superannotatecli create-folder --project “Project Name” --name “Folder Name”

Search folders

To search for folders in a project:

SAClient.search_folders(
   project="Car Project",
   folder_name="Folder 1",
   status="InProgress",
   return_metadata=False
)

The status field can have one of the following values: NotStarted, InProgress, Completed, OnHold, and Undefined.

Set folder status

To set the status of a folder:

SAClient.set_folder_status(
  Project = "Project 1"
	Folder = "Folder A"
	Status = "InProgress")

The status should be one of the following: NotStarted, InProgress, Completed” or OnHold.

Delete folder

To delete a list of folders:

sa.delete_folders(
    project = "Project Name",
    folder_names = ["Folder 1", "Folder 2"])