The WORK service is designed as a collection of operations, or use cases.
Service |
Description |
get_folder_by_userid |
Returns a list of root folders available for a given user. These folders are displayed in a tree format. The top level of the tree consists of all the folders a particular user has permission to see, which is determined by his / her role. |
get_folder_by_project |
Returns a list of root folders available for a given project across all users in the project. These folders are displayed in a tree format. A user must have manager permission and be configured as such to see all folders in a project. |
get_children |
Expands any level of a folder, providing information about its contents, for a given user. |
rename_child |
Renames a work item (leaf or folder) in the workplace tree. |
delete_child |
Deletes a work item (leaf or folder) in the workplace tree. |
add_child |
Adds a work item (leaf or folder) in the workplace tree. |
annotate_child |
Annotates a work item (leaf or folder) in the workplace tree by modifying or adding a tooltip. |
move_child |
Moves a work item (leaf or folder) in the workplace tree and reassigns all its children. |
export_child |
Export a work item (leaf or folder) as XML to a local file. |
get_name_info |
Returns information needed about all work item related to a given search keyword or name. |
set_protected_access |
This webservice will let users set the protected access on any folder or any contents of the folder. If user sets protected access to a folder, all the contents of the folder will recursively get protected access. |