WorkspaceAPI

org       = ac.get_org_instance(ORG_ID)
workspace = ac.get_workspace_instance(ORG_ID, WORKSPACE_ID)
view      = ac.get_view_instance(ORG_ID, WORKSPACE_ID, VIEW_ID)
bulk      = ac.get_bulk_instance(ORG_ID, WORKSPACE_ID)

WorkspaceAPI exposes 117 methods. Method names are snake_case and identifiers are string.

Methods#

add_admins, add_default, add_favorite, add_group_members, add_tag_to_views, add_workspace_users, automl_analysis_prediction, backup_workspace_now, change_alert_status, change_email_schedule_status, change_folder_hierarchy, change_folder_position, change_workspace_user_role, change_workspace_user_status, copy, copy_views, create_automl_analysis, create_automl_analysis_deployment, create_dashboard, create_email_schedule, create_folder, create_group, create_query_table, create_report, create_slideshow, create_table, create_tag, create_variable, delete, delete_alerts, delete_automl_analysis, delete_automl_analysis_deployment, delete_automl_analysis_model, delete_email_schedule, delete_folder, delete_group, delete_slideshow, delete_tag, delete_trash_views, delete_variable, deploy_automl_analysis, disable_domain_access, download_workspace_backup, edit_query_table, enable_domain_access, export_as_template, get_admins, get_aggregate_formula_dependents, get_aggregate_formula_value, get_aggregate_formulas, get_alert_configuration, get_alert_events, get_alerts_in_workspace, get_automl_analysis, get_automl_analysis_details, get_dashboard_metadata, get_datasources, get_deployment_details, get_email_schedules, get_folders, get_group_details, get_groups, get_linkable_workspaces, get_linked_workspace_sync_details, get_linked_workspaces, get_query_table_details, get_query_tables, get_report_metadata, get_secret_key, get_share_info, get_shared_details_for_views, get_slideshow_details, get_slideshow_url, get_slideshows, get_tagged_views, get_tags, get_trash_views, get_variable_details, get_variables, get_views, get_workspace_access_restrictions, get_workspace_backup_status, get_workspace_backups, get_workspace_details, get_workspace_linking_compatibility, get_workspace_restore_status, get_workspace_users, link_workspaces, make_default_folder, move_views_to_folder, remove_admins, remove_default, remove_favorite, remove_group_members, remove_share, remove_tag_from_views, remove_workspace_users, rename, rename_folder, rename_group, restore_trash_views, restore_workspace_from_backup, run_alert, share_views, sync_data, sync_linked_workspaces, trigger_email_schedule, unlink_workspaces, update_alert, update_dashboard, update_datasource_connection, update_email_schedule, update_report, update_slideshow, update_tag, update_variable, update_workspace_access_restrictions

add_admins#

add_admins(email_ids, config = {})

Add admins to the workspace.

add_default#

add_default()

Set the workspace as default.

add_favorite#

add_favorite()

Mark the workspace as favorite.

add_group_members#

add_group_members(group_id, email_ids, config = {})

Add users to a group.

add_tag_to_views#

add_tag_to_views(tag_id, view_ids, config = {})

Adds the specified tag to multiple views in the workspace.

add_workspace_users#

add_workspace_users(email_ids, role, config = {})

Add users to the workspace.

automl_analysis_prediction#

automl_analysis_prediction(analysis_id, model_id, features, config = {})

Gets predictions by providing sample input values for a trained AutoML model.

Returns (Hash) — Prediction result

backup_workspace_now#

backup_workspace_now(config = {})

Trigger an instant backup for the specified workspace.

Returns (Hash) — Triggered backup details

change_alert_status#

change_alert_status(alert_ids, enabled, config = {})

Enable or disable the specified data alerts in the workspace.

change_email_schedule_status#

change_email_schedule_status(schedule_id, operation)

Update email schedule status (activate or deactivate).

change_folder_hierarchy#

change_folder_hierarchy(folder_id, hierarchy, config = {})

Change folder hierarchy (parent/child).

change_folder_position#

change_folder_position(folder_id, reference_folder_id, config = {})

Reorder folder relative to another folder.

change_workspace_user_role#

change_workspace_user_role(email_ids, role, config = {})

Change role of workspace users.

change_workspace_user_status#

change_workspace_user_status(email_ids, operation, config = {})

Change status (activate/deactivate) of workspace users.

copy#

copy(new_workspace_name, config = {}, dest_org_id = nil)

Copy the specified workspace to a new one.

Returns (Integer) — Copied workspace ID

copy_views#

copy_views(view_ids, dest_workspace_id, config = {}, dest_org_id = nil)

Copy views to another workspace.

Returns (Array) — Copied views

create_automl_analysis#

create_automl_analysis()

Creates a new AutoML analysis in the workspace.

Returns (String) — Created AutoML analysis ID

create_automl_analysis_deployment#

create_automl_analysis_deployment()

Deploys an AutoML analysis model.

Returns (Array) — Deployment details

create_dashboard#

create_dashboard(display_name, layout, config = {})

Create a dashboard in the specified workspace.

Returns (String) — Created dashboard id

create_email_schedule#

create_email_schedule(schedule_name, view_ids, format, email_ids, schedule_details, config = {})

Create an email schedule in the specified workspace.

Returns (String) — created email schedule ID

create_folder#

create_folder(folder_name, config = {})

Create a new folder in the workspace.

Returns (Integer) — Created folder ID

create_group#

create_group(group_name, email_ids, config = {})

Create a group.

Returns (Integer) — Group ID

create_query_table#

create_query_table(sql_query, query_table_name, config = {})

Create a new query table in the workspace.

Returns (Integer) — Created view ID

create_report#

create_report(config = {})

Create a report in the specified workspace.

Returns (Integer) — created view ID

create_slideshow#

create_slideshow(slide_name, view_ids, config = {})

Create a slideshow in the workspace.

Returns (Integer) — Slideshow ID

create_table#

create_table(table_design)

Create a new table in the workspace.

Returns (Integer) — Created view ID

create_tag#

create_tag(tag_name, color_code, config = {})

Create a tag in the specified workspace.

Returns (String) — Created tag id

create_variable#

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

Create a variable in the workspace.

Returns (Integer) — Variable ID

delete#

delete()

Delete the specified workspace.

delete_alerts#

delete_alerts(alert_ids, config = {})

Delete the specified data alerts from the workspace.

delete_automl_analysis#

delete_automl_analysis(analysis_id, config = {})

Deletes the specified AutoML analysis from the workspace.

delete_automl_analysis_deployment#

delete_automl_analysis_deployment(analysis_id, deployment_id, config = {})

Deletes an AutoML analysis deployment.

delete_automl_analysis_model#

delete_automl_analysis_model(analysis_id, model_id, config = {})

Deletes a specific model from the given AutoML analysis.

delete_email_schedule#

delete_email_schedule(schedule_id)

Delete the specified email schedule.

delete_folder#

delete_folder(folder_id)

Delete a folder.

delete_group#

delete_group(group_id)

Delete a group.

delete_slideshow#

delete_slideshow(slide_id)

Delete a slideshow.

delete_tag#

delete_tag(tag_id)

Delete the specified tag from the workspace.

delete_trash_views#

delete_trash_views(view_id, config = {})

Permanently delete a view from trash.

delete_variable#

delete_variable(variable_id)

Delete a variable from the workspace.

deploy_automl_analysis#

deploy_automl_analysis(analysis_id, deployment_id, config = {})

Executes an AutoML analysis deployment.

disable_domain_access#

disable_domain_access()

Disable white-label domain access for the workspace.

download_workspace_backup#

download_workspace_backup(backup_id, file_path, config = {})

Download the specified workspace backup.

edit_query_table#

edit_query_table(view_id, sql_query, config = {})

Update an existing query table.

enable_domain_access#

enable_domain_access()

Enable the workspace for white-label domain access.

export_as_template#

export_as_template(view_ids, file_path, config = {})

Export views as a template file.

get_admins#

get_admins()

Get list of admins for the workspace.

Returns (Array) — Admin details

get_aggregate_formula_dependents#

get_aggregate_formula_dependents(formula_id)

Returns dependents for a specified aggregate formula.

Returns (Hash) — dependent views and formulas

get_aggregate_formula_value#

get_aggregate_formula_value(formula_id)

Returns the value of the aggregate formula.

Returns (String) — formula value

get_aggregate_formulas#

get_aggregate_formulas(config = {})

Returns list of all aggregate formulas for the specified workspace.

Returns (Array) — list of aggregate formulas

get_alert_configuration#

get_alert_configuration(alert_id)

Returns the configuration of the specified data alert.

Returns (Hash) — Data alert configuration

get_alert_events#

get_alert_events(alert_id, config = {})

Returns the execution events of the specified data alert.

Returns (Hash) — Data alert events along with the page details

get_alerts_in_workspace#

get_alerts_in_workspace()

Returns list of data alerts available in the specified workspace.

Returns (Array) — Data alerts list

get_automl_analysis#

get_automl_analysis()

Returns all AutoML analyses for the workspace.

Returns (Array) — AutoML analysis list

get_automl_analysis_details#

get_automl_analysis_details(analysis_id)

Retrieves detailed information for a specific AutoML analysis.

Returns (Hash) — AutoML analysis details

get_dashboard_metadata#

get_dashboard_metadata(dashboard_id, config = {})

Returns the metadata of the specified dashboard.

Returns (Hash) — Dashboard configuration

get_datasources#

get_datasources()

Get list of data sources.

Returns (Array) — List of data sources

get_deployment_details#

get_deployment_details(analysis_id, model_id)

Returns deployment details for an AutoML analysis model.

Returns (Array) — Deployment details

get_email_schedules#

get_email_schedules()

Returns list of email schedules available in the specified workspace.

Returns (Array) — list of email schedules

get_folders#

get_folders()

Returns a list of all accessible folders in the workspace.

Returns (Array) — Folder list

get_group_details#

get_group_details(group_id)

Get details for a group.

Returns (Hash) — Group details

get_groups#

get_groups()

Get groups in the workspace.

Returns (Array) — Group list

get_linkable_workspaces#

get_linkable_workspaces()

Returns list of organizations and workspaces that can be linked to the specified master workspace.

Returns (Array) — Organizations with their linkable workspaces

get_linked_workspace_sync_details#

get_linked_workspace_sync_details(sandbox_ids, config = {})

Returns the sync details of the specified linked workspaces.

Returns (Array) — Linked workspace sync details

get_linked_workspaces#

get_linked_workspaces()

Returns list of workspaces linked to the specified master workspace.

Returns (Array) — Linked workspaces list

get_query_table_details#

get_query_table_details(query_table_id)

Returns details of the specified query table.

Returns (Hash) — Query table details

get_query_tables#

get_query_tables(config = {})

Returns list of all query tables for the specified workspace.

Returns (Array) — Query table list

get_report_metadata#

get_report_metadata(view_id)

Returns the metadata of the specified report.

Returns (Hash) — Report configuration

get_secret_key#

get_secret_key(config = {})

Get the secret key for the workspace.

Returns (String) — Secret key

get_share_info#

get_share_info()

Get workspace share info.

Returns (Hash) — Share information

get_shared_details_for_views#

get_shared_details_for_views(view_ids)

Get shared details for the given views.

Returns (Array) — Shared detail entries

get_slideshow_details#

get_slideshow_details(slide_id)

Get slideshow details.

Returns (Hash) — Slideshow details

get_slideshow_url#

get_slideshow_url(slide_id, config = {})

Get URL to access a slideshow.

Returns (String) — Published URL

get_slideshows#

get_slideshows()

Get all slideshows in the workspace.

Returns (Array) — Slideshow list

get_tagged_views#

get_tagged_views(tag_id)

Returns the list of views associated with the specified tag.

Returns (Array) — Tagged views list

get_tags#

get_tags()

Returns list of all tags for the specified workspace.

Returns (Array) — Tags list

get_trash_views#

get_trash_views()

Get list of trash views.

Returns (Array) — Trash views

get_variable_details#

get_variable_details(variable_id)

Get details of a specific variable.

Returns (Hash) — Variable details

get_variables#

get_variables()

Get list of variables in the workspace.

Returns (Array) — List of variables

get_views#

get_views(config = {})

Get list of all views in the workspace.

Returns (Array) — View list

get_workspace_access_restrictions#

get_workspace_access_restrictions()

Returns the access restriction settings configured for the specified workspace.

Returns (Hash) — Workspace access restriction settings

get_workspace_backup_status#

get_workspace_backup_status(backup_id)

Returns the status of the specified workspace backup.

Returns (Hash) — Backup status details

get_workspace_backups#

get_workspace_backups()

Returns the backup configuration and the list of backups available for the specified workspace.

Returns (Hash) — Workspace backup details

get_workspace_details#

get_workspace_details(config = {})

Returns details of the specified workspace.

Returns (Hash) — Workspace details

get_workspace_linking_compatibility#

get_workspace_linking_compatibility(clients, config = {})

Returns the linking compatibility details for the specified client workspaces.

Returns (Array) — Client workspace compatibility details

get_workspace_restore_status#

get_workspace_restore_status(restore_id)

Returns the status of the specified workspace restore.

Returns (Hash) — Restore status details

get_workspace_users#

get_workspace_users()

Get users in the workspace.

Returns (Array) — User list

link_workspaces#

link_workspaces(clients, config = {})

Link the specified client workspaces to the master workspace.

make_default_folder#

make_default_folder(folder_id)

Mark a folder as default.

move_views_to_folder#

move_views_to_folder(folder_id, view_ids, config = {})

Move views into a folder.

remove_admins#

remove_admins(email_ids, config = {})

Remove admins from the workspace.

remove_default#

remove_default()

Unset the workspace from default.

remove_favorite#

remove_favorite()

Unmark the workspace as favorite.

remove_group_members#

remove_group_members(group_id, email_ids, config = {})

Remove users from a group.

remove_share#

remove_share(view_ids, email_ids, config = {})

Remove shared views for specific users.

remove_tag_from_views#

remove_tag_from_views(tag_id, view_ids = nil, dissociate_all = false, config = {})

Removes the specified tag from multiple views in the workspace.

remove_workspace_users#

remove_workspace_users(email_ids, config = {})

Remove users from the workspace.

rename#

rename(workspace_name, config = {})

Rename the specified workspace.

rename_folder#

rename_folder(folder_id, folder_name, config = {})

Rename a folder.

rename_group#

rename_group(group_id, group_name, config = {})

Rename a group.

restore_trash_views#

restore_trash_views(view_id, config = {})

Restore a view from trash.

restore_workspace_from_backup#

restore_workspace_from_backup(backup_id, confirm_restore, config = {})

Restore the specified workspace from the given backup.

Returns (Hash) — Triggered restore details

run_alert#

run_alert(alert_id, config = {})

Execute the specified data alert immediately.

share_views#

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

Share views to users.

sync_data#

sync_data(datasource_id, config = {})

Trigger data sync for a data source.

sync_linked_workspaces#

sync_linked_workspaces(scope, config = {})

Sync the metadata of the master workspace to its linked client workspaces.

trigger_email_schedule#

trigger_email_schedule(schedule_id)

Trigger the configured email schedule instantly.

unlink_workspaces#

unlink_workspaces(scope, config = {})

Unlink the client workspaces from the specified master workspace.

update_alert#

update_alert(alert_id, alert_name, schedule_details, rules, config = {})

Update the specified data alert in the workspace.

update_dashboard#

update_dashboard(dashboard_id, config = {})

Update the specified dashboard in the workspace.

update_datasource_connection#

update_datasource_connection(datasource_id, config = {})

Update data source connection.

update_email_schedule#

update_email_schedule(schedule_id, config)

Update configurations of the specified email schedule.

Returns (String) — updated schedule ID

update_report#

update_report(view_id, config = {})

Update the design and configuration of the specified report.

update_slideshow#

update_slideshow(slide_id, config = {})

Update a slideshow.

update_tag#

update_tag(tag_id, config = {})

Update details of the specified tag in the workspace.

update_variable#

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

Update a variable in the workspace.

update_workspace_access_restrictions#

update_workspace_access_restrictions(config = {})

Update the access restriction settings of the specified workspace.

Related#

• Errors — the failure envelope and codes worth branching on.
• Limits — throttles and quotas that apply to these calls.