Workspace¶
-
organization.workspace.
add_app
(organization_id, workspace_id, app_id)¶ Adds a PlaidCloud registered app to a workspace for use
-
organization.workspace.
add_label
(organization_id, worspace_id, label)¶ Sets a label on a workspace
-
organization.workspace.
apps
(organization_id, workspace_id)¶ Provides a list of registered apps with the workspace
-
organization.workspace.
copy
(organization_id, workspace_id, rollup_id, after_position)¶ Copies a workspace
-
organization.workspace.
create
(organization_id, rollup_id, name, memo)¶ Creates a workspace within an organization
-
organization.workspace.
create_label
(organization_id, worspace_id, name)¶ Creates a workspace label
-
organization.workspace.
create_rollup
(organization_id, rollup_id, position, name)¶ Creates a folder in the workspace hierarchy
-
organization.workspace.
delete
(organization_id, workspace_id)¶ Deletes a workspace and all associated projects, workflows, data, etc…
-
organization.workspace.
delete_label
(organization_id, worspace_id, label)¶ Deletes a workspace label
-
organization.workspace.
delete_rollup
(organization_id, workspace_id)¶ Deletes a folder and its contents in the workspace hierarchy
-
organization.workspace.
disable
(organization_id, workspace_id)¶ Set the workspace to disabled to prevent usage and access
-
organization.workspace.
enable
(organization_id, workspace_id)¶ Sets the workspace to enabled to allow access
-
organization.workspace.
get_welcome_message
()¶ Gets the current welcome email message for new members
- Returns
welcome message text
- Return type
-
organization.workspace.
id_from_path
(organization_id, path)¶ Provides the cannonical id for the from a provided path
-
organization.workspace.
labels
(organization_id)¶ Provides a list of labels for workspaces
- Parameters
organization_id (str) – Unique organization identifier
- Returns
None
-
organization.workspace.
make_rollups
(organization_id, workspace_id)¶ Creates the path and all intermediate rollup points
-
organization.workspace.
move
(organization_id, workspace_id, rollup_id, after_position)¶ Moves a workspace in the hierarchy
-
organization.workspace.
paths_from_id
(organization_id, workspace_id)¶ Provides a list of paths associated with the cannonical id
-
organization.workspace.
remove_app
(organization_id, workspace_id, app_id)¶ Removes registered PlaidCloud app from the workspace
-
organization.workspace.
remove_label
(organization_id, worspace_id, label)¶ Removes a label on a workspace
-
organization.workspace.
search_by_label
(organization_id, workspace_id, text, criteria='contains')¶ Returns list of workspaces that match the search criteria
-
organization.workspace.
search_by_name
(organization_id, workspace_id, text, criteria='contains')¶ Returns list of workspaces that match the search criteria
-
organization.workspace.
set_welcome_message
(message)¶ Sets the welcome email message for new members
- Parameters
message (str) – The new welcome message
- Returns
None
-
organization.workspace.
update
(organization_id, workspace_id, **kwargs)¶ Updates a workspace name and memo
- Parameters
- Kwargs:
name (str): The object name memo (str): The object description
- Returns
None
-
organization.workspace.
update_label
(organization_id, worspace_id, label, name)¶ Creates a workspace label
-
organization.workspace.
update_rollup
(organization_id, workspace_id, **kwargs)¶ Updates a folder name in the workspace hierarchy
- Parameters
- Kwargs:
rollup_id (str): Unique rollup identifier position (int): The position order of the object within the rollup name (str): The object name
- Returns
None
-
organization.workspace.
workspace
(organization_id, workspace_id)¶ Provides detailed information about the workspace
-
organization.workspace.
workspaces
(organization_id, id_filter=None)¶ Provides a list of workspaces within the specified organization
-
organization.workspace.
workspaces_from_labels
(organization_id, labels)¶ Provides list of workspaces for based on set of labels. Uses AND condition.
-
organization.workspace.
workspaces_from_path
(organization_id, path)¶ Provides list of workspaces based on a path fragment. Path fragment can be to parent level.