workspace.py

Workspace (CelonisApiObject)

Workspace object to interact with Celonis Process Analytics API.

url: str property readonly

API

• /process-mining/api/processes/{workspace_id}

analyses: CelonisCollection[Analysis] property readonly

Get all Analyses in the Workspace.

API

• GET: /process-mining/api/analysis/{analysis_id}?processId={workspace_id}

Returns:

Type	Description
CelonisCollection[Analysis]	Collection of Analyses in the Workspace.

pool: Pool property readonly

Get the Pool the Workspace is connected to.

datamodel: Datamodel property readonly

Get the Datamodel the Workspace is connected to.

Exceptions:

Type	Description
PyCelonisNotFoundError	If the Datamodel was not found or needs to reloaded.

create_analysis(self, name=None, content_backup=None)

Creates a new Analysis in the Workspace

Parameters:

Name	Type	Description	Default
name	str	Name of the Analysis.	None
content_backup	Union[str, pathlib.Path]	Path to an Analysis Backup that will be restored to this Analysis.	None

Returns:

Type	Description
Analysis	The newly created Analysis object.

move(self, to, target_workspace=None)

Moves the Workspace to another team.

API

• POST: /process-mining/api/processes/move

  {
      "analysisIdsToReplace": [],
      "sourceWorkspaceId": self.id,
      "targetWorkspaceId": target_workspace,
      "teamDomain": to
  }
  

Parameters:

Name	Type	Description	Default
to	str	Team name (e.g. move for https://move.eu-1.celonis.cloud)	required
target_workspace	Workspace	Workspace ID or Workspace object where the analysis should be copied to.	None