Home       Trees       Indices       Help   
Module AnalyticsClient :: Class AnalyticsClient :: Class WorkspaceAPI
[hide private]
[frames] | no frames]

Class WorkspaceAPI

source code

WorkspaceAPI contains workspace level operations.

Instance Methods [hide private]
 
__init__(self, ac, org_id, workspace_id) source code
string
copy(self, new_workspace_name, config={}, dest_org_id=None)
Copy the specified workspace from one organization to another or within the organization.		 source code
 
rename(self, workspace_name, config={})
Rename a specified workspace in the organization.		 source code
 
delete(self)
Delete a specified workspace in the organization.		 source code
string
get_secret_key(self, config={})
Returns the secret key of the specified workspace.		 source code
 
add_favorite(self)
Adds a specified workspace as favorite.		 source code
 
remove_favorite(self)
Remove a specified workspace from favorite.		 source code
 
add_default(self)
Adds a specified workspace as default.		 source code
 
remove_default(self)
Remove a specified workspace from default.		 source code
list
get_admins(self)
Returns list of admins for the specified workspace.		 source code
 
add_admins(self, email_ids, config={})
Add admins for the specified workspace.		 source code
 
remove_admins(self, email_ids, config={})
Remove admins from the specified workspace.		 source code
dictionary
get_share_info(self)
Returns shared details of the specified workspace.		 source code
 
share_views(self, view_ids, email_ids, permissions, config={})
Share views to the specified users.		 source code
 
remove_share(self, view_ids, email_ids, config={})
Remove shared views for the specified users.		 source code
list
get_shared_details_for_views(self, view_ids)
Returns shared details of the specified views.		 source code
list
get_folders(self)
Returns list of all accessible folders for the specified workspace.		 source code
string
create_folder(self, folder_name, config={})
Create a folder in the specified workspace.		 source code
list
get_views(self, config={})
Returns list of all accessible views for the specified workspace.		 source code
string
create_table(self, table_design)
Create a table in the specified workspace.		 source code
string
create_query_table(self, sql_query, query_table_name, config={})
Create a new query table in the workspace.		 source code
 
edit_query_table(self, view_id, sql_query, config={})
Update the mentioned query table in the workspace.		 source code
list
copy_views(self, view_ids, dest_workspace_id, config={}, dest_org_id=None)
Copy the specified views from one workspace to another workspace.		 source code
 
enable_domain_access(self)
Enable workspace to the specified white label domain.		 source code
 
disable_domain_access(self)
Disable workspace from the specified white label domain.		 source code
 
rename_folder(self, folder_id, folder_name, config={})
Rename a specified folder in the workspace.		 source code
 
delete_folder(self, folder_id)
Delete a specified folder in the workspace.		 source code
list
get_groups(self)
Returns list of groups for the specified workspace.		 source code
string
create_group(self, group_name, email_ids, config={})
Create a group in the specified workspace.		 source code
dictionary
get_group_details(self, group_id)
Get the details of the specified group.		 source code
 
rename_group(self, group_id, group_name, config={})
Rename a specified group.		 source code
 
delete_group(self, group_id)
Delete a specified group.		 source code
 
add_group_members(self, group_id, email_ids, config={})
Add users to the specified group.		 source code
 
remove_group_members(self, group_id, email_ids, config={})
Remove users from the specified group.		 source code
string
create_slideshow(self, slide_name, view_ids, config={})
Create a slideshow in the specified workspace.		 source code
 
update_slideshow(self, slide_id, config={})
Update details of the specified slideshow.		 source code
 
delete_slideshow(self, slide_id)
Delete a specified slideshow in the workspace.		 source code
list
get_slideshows(self)
Returns list of slideshows for the specified workspace.		 source code
string
get_slideshow_url(self, slide_id, config={})
Returns slide URL to access the specified slideshow.		 source code
dictionary
get_slideshow_details(self, slide_id)
Returns details of the specified slideshow.		 source code
string
create_variable(self, variable_name, variable_datatype, variable_type, config={})
Create a variable in the workspace.		 source code
 
update_variable(self, variable_id, variable_name, variable_datatype, variable_type, config={})
Update details of the specified variable in the workspace.		 source code
 
delete_variable(self, variable_id)
Delete the specified variable in the workspace.		 source code
list
get_variables(self)
Returns list of variables for the specified workspace.		 source code
dictionary
get_variable_details(self, variable_id)
Returns list of variables for the specified workspace.		 source code
 
make_default_folder(self, folder_id)
Make the specified folder as default.		 source code
list
get_datasources(self)
Returns list of datasources for the specified workspace.		 source code
 
sync_data(self, datasource_id, config={})
Initiate data sync for the specified datasource.		 source code
 
update_datasource_connection(self, datasource_id, config={})
Update connection details for the specified datasource.		 source code
list
get_trash_views(self)
Initiate data sync for the specified datasource.		 source code
 
restore_trash_views(self, view_id, config={})
Restore the specified view from trash.		 source code
 
delete_trash_views(self, view_id, config={})
Delete the specified view permanently from trash.		 source code
 
change_folder_hierarchy(self, folder_id, hierarchy, config={})
Swaps the hierarchy of a parent folder and a subfolder.		 source code
 
change_folder_position(self, folder_id, reference_folder_id, config={})
Place the folder above the reference folder.		 source code
 
move_views_to_folder(self, folder_id, view_ids, config={})
Move views to the mentioned folder.		 source code
 
export_as_template(self, view_ids, file_path, config={})
Export the mentioned views as templates.		 source code
list
get_workspace_users(self)
Returns list of users for the specified workspace.		 source code
 
add_workspace_users(self, email_ids, role, config={})
Add users to the specified workspace.		 source code
 
remove_workspace_users(self, email_ids, config={})
Remove users from the specified workspace.		 source code
 
change_workspace_user_status(self, email_ids, operation, config={})
Change users staus in the specified workspace.		 source code
 
change_workspace_user_role(self, email_ids, role, config={})
Change role for the specified users.		 source code
Method Details [hide private]

copy(self, new_workspace_name, config={}, dest_org_id=None)

source code 

Copy the specified workspace from one organization to another or within the organization.

Parameters:
  • new_workspace_name (string) - Name of the new workspace.
  • config (dictionary) - Contains any additional control parameters. Can be None.
  • dest_org_id (string) - Id of the organization where the destination workspace is present. Can be None.
Returns: string
Copied workspace id.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

rename(self, workspace_name, config={})

source code 

Rename a specified workspace in the organization.

Parameters:
  • workspace_name (string) - New name for the workspace.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete(self)

source code 

Delete a specified workspace in the organization.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_secret_key(self, config={})

source code 

Returns the secret key of the specified workspace.

Parameters:
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Workspace secret key.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

add_favorite(self)

source code 

Adds a specified workspace as favorite.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_favorite(self)

source code 

Remove a specified workspace from favorite.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

add_default(self)

source code 

Adds a specified workspace as default.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_default(self)

source code 

Remove a specified workspace from default.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_admins(self)

source code 

Returns list of admins for the specified workspace.

Returns: list
Workspace admin list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

add_admins(self, email_ids, config={})

source code 

Add admins for the specified workspace.

Parameters:
  • email_ids (list) - The email address of the admin users to be added.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_admins(self, email_ids, config={})

source code 

Remove admins from the specified workspace.

Parameters:
  • email_ids (list) - The email address of the admin users to be removed.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_share_info(self)

source code 

Returns shared details of the specified workspace.

Returns: dictionary
Workspace share info.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

share_views(self, view_ids, email_ids, permissions, config={})

source code 

Share views to the specified users.

Parameters:
  • view_ids (list) - View ids which to be shared.
  • email_ids (list) - The email address of the users to whom the views need to be shared.
  • permissions (dictionary) - Contains permission details.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_share(self, view_ids, email_ids, config={})

source code 

Remove shared views for the specified users.

Parameters:
  • view_ids (list) - View ids whose sharing needs to be removed.
  • email_ids (list) - The email address of the users to whom the sharing need to be removed.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_shared_details_for_views(self, view_ids)

source code 

Returns shared details of the specified views.

Parameters:
  • view_ids (list) - View ids for which sharing details are required.
Returns: list
Shared information.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_folders(self)

source code 

Returns list of all accessible folders for the specified workspace.

Returns: list
Folder list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_folder(self, folder_name, config={})

source code 

Create a folder in the specified workspace.

Parameters:
  • folder_name (string) - Name of the folder to be created.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Created folder id.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_views(self, config={})

source code 

Returns list of all accessible views for the specified workspace.

Parameters:
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: list
View list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_table(self, table_design)

source code 

Create a table in the specified workspace.

Parameters:
  • table_design (dictionary) - Table structure.
Returns: string
created table id.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_query_table(self, sql_query, query_table_name, config={})

source code 

Create a new query table in the workspace.

Parameters:
  • sql_query (string) - SQL query to construct the query table.
  • query_table_name (string) - Name of the query table to be created.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
created table id.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

edit_query_table(self, view_id, sql_query, config={})

source code 

Update the mentioned query table in the workspace.

Parameters:
  • view_id (string) - Id of the query table to be updated.
  • sql_query (string) - New SQL query to be updated.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

copy_views(self, view_ids, dest_workspace_id, config={}, dest_org_id=None)

source code 

Copy the specified views from one workspace to another workspace.

Parameters:
  • view_ids (list) - The id of the views to be copied.
  • dest_workspace_id (string) - The destination workspace id.
  • dest_org_id (string) - Id of the organization where the destination workspace is present. Can be None.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: list
View list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

enable_domain_access(self)

source code 

Enable workspace to the specified white label domain.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

disable_domain_access(self)

source code 

Disable workspace from the specified white label domain.

Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

rename_folder(self, folder_id, folder_name, config={})

source code 

Rename a specified folder in the workspace.

Parameters:
  • folder_id (string) - Id of the folder.
  • folder_name (string) - New name for the folder.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete_folder(self, folder_id)

source code 

Delete a specified folder in the workspace.

Parameters:
  • folder_id (string) - Id of the folder to be deleted.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_groups(self)

source code 

Returns list of groups for the specified workspace.

Returns: list
Group list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_group(self, group_name, email_ids, config={})

source code 

Create a group in the specified workspace.

Parameters:
  • group_name (string) - Name of the group.
  • email_ids (list) - The email address of the users to be added to the group.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Created group id.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_group_details(self, group_id)

source code 

Get the details of the specified group.

Parameters:
  • group_id (string) - Id of the group.
Returns: dictionary
Details of the specified group.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

rename_group(self, group_id, group_name, config={})

source code 

Rename a specified group.

Parameters:
  • group_id (string) - Id of the group.
  • group_name (string) - New name for the group.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete_group(self, group_id)

source code 

Delete a specified group.

Parameters:
  • group_id (string) - The id of the group.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

add_group_members(self, group_id, email_ids, config={})

source code 

Add users to the specified group.

Parameters:
  • group_id (string) - Id of the group.
  • email_ids (list) - The email address of the users to be added to the group.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_group_members(self, group_id, email_ids, config={})

source code 

Remove users from the specified group.

Parameters:
  • group_id (string) - Id of the group.
  • email_ids (list) - The email address of the users to be removed from the group.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_slideshow(self, slide_name, view_ids, config={})

source code 

Create a slideshow in the specified workspace.

Parameters:
  • slide_name (string) - Name of the slideshow to be created.
  • view_ids (list) - Ids of the view to be included in the slideshow.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Id of the created slideshow.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

update_slideshow(self, slide_id, config={})

source code 

Update details of the specified slideshow.

Parameters:
  • slide_id (string @param config - Contains the control configurations.) - The id of the slideshow.
  • config (dictionary)
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete_slideshow(self, slide_id)

source code 

Delete a specified slideshow in the workspace.

Parameters:
  • slide_id (string) - Id of the slideshow.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_slideshows(self)

source code 

Returns list of slideshows for the specified workspace.

Returns: list
Slideshow list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_slideshow_url(self, slide_id, config={})

source code 

Returns slide URL to access the specified slideshow.

Parameters:
  • slide_id (string) - Id of the slideshow.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Returns: string
Slideshow URL.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_slideshow_details(self, slide_id)

source code 

Returns details of the specified slideshow.

Parameters:
  • slide_id (string) - Id of the slideshow.
Returns: dictionary
Slideshow details.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

create_variable(self, variable_name, variable_datatype, variable_type, config={})

source code 

Create a variable in the workspace.

Parameters:
  • variable_name (string) - Name of the variable to be created.
  • variable_datatype (string) - Datatype of the variable to be created.
  • variable_type (string) - Type of the variable to be created.
  • config (dictionary) - Contains the control parameters.
Returns: string
Id of the created variable.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

update_variable(self, variable_id, variable_name, variable_datatype, variable_type, config={})

source code 

Update details of the specified variable in the workspace.

Parameters:
  • variable_id (string) - Id of the variable.
  • variable_name (string) - New name for the variable.
  • variable_datatype (string) - New datatype for the variable.
  • variable_type (string) - New type for the variable.
  • config (dictionary) - Contains the control parameters.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete_variable(self, variable_id)

source code 

Delete the specified variable in the workspace.

Parameters:
  • variable_id (string) - Id of the variable.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_variables(self)

source code 

Returns list of variables for the specified workspace.

Returns: list
Variable list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_variable_details(self, variable_id)

source code 

Returns list of variables for the specified workspace.

Parameters:
  • variable_id (string) - Id of the variable.
Returns: dictionary
Variable details.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

make_default_folder(self, folder_id)

source code 

Make the specified folder as default.

Parameters:
  • folder_id (string) - Id of the folder.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_datasources(self)

source code 

Returns list of datasources for the specified workspace.

Returns: list
Datasource list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

sync_data(self, datasource_id, config={})

source code 

Initiate data sync for the specified datasource.

Parameters:
  • datasource_id (string) - Id of the datasource.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

update_datasource_connection(self, datasource_id, config={})

source code 

Update connection details for the specified datasource.

Parameters:
  • datasource_id (string) - Id of the datasource.
  • config (dictionary) - Contains the control parameters.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_trash_views(self)

source code 

Initiate data sync for the specified datasource.

Returns: list
Trash view list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

restore_trash_views(self, view_id, config={})

source code 

Restore the specified view from trash.

Parameters:
  • view_id (string) - Id of the view.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

delete_trash_views(self, view_id, config={})

source code 

Delete the specified view permanently from trash.

Parameters:
  • view_id (string) - Id of the view.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

change_folder_hierarchy(self, folder_id, hierarchy, config={})

source code 

Swaps the hierarchy of a parent folder and a subfolder.

Parameters:
  • folder_id (string) - Id of the folder.
  • hierarchy (string) - New hierarchy for the folder. (0 - Parent; 1 - Child).
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

change_folder_position(self, folder_id, reference_folder_id, config={})

source code 

Place the folder above the reference folder.

Parameters:
  • folder_id (string) - Id of the folder.
  • reference_folder_id (string) - Id of the reference folder.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

move_views_to_folder(self, folder_id, view_ids, config={})

source code 

Move views to the mentioned folder.

Parameters:
  • folder_id (string) - Id of the folder.
  • view_ids (list) - View ids to be moved.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

export_as_template(self, view_ids, file_path, config={})

source code 

Export the mentioned views as templates.

Parameters:
  • view_ids (list) - Ids of the views to be exported.
  • file_path (string) - Path of the file where the data exported to be stored. ( Should be in 'atpt' format )
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

get_workspace_users(self)

source code 

Returns list of users for the specified workspace.

Returns: list
User list.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

add_workspace_users(self, email_ids, role, config={})

source code 

Add users to the specified workspace.

Parameters:
  • email_ids (list) - The email address of the users to be added.
  • role (string) - Role of the user to be added.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

remove_workspace_users(self, email_ids, config={})

source code 

Remove users from the specified workspace.

Parameters:
  • email_ids (list) - The email address of the users to be removed.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

change_workspace_user_status(self, email_ids, operation, config={})

source code 

Change users staus in the specified workspace.

Parameters:
  • email_ids (list) - The email address of the users.
  • operation (string) - New status for the users ( Values - activate | deactivate ).
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

change_workspace_user_role(self, email_ids, role, config={})

source code 

Change role for the specified users.

Parameters:
  • email_ids (list) - The email address of the users.
  • role (string) - New role for the users.
  • config (dictionary) - Contains any additional control parameters. Can be None.
Raises:
  • ServerError - If the server has received the request but did not process the request due to some error.
  • ParseError - If the server has responded but client was not able to parse the response.

   Home       Trees       Indices       Help