API Reference

Connecting objects

get_celonis([celonis_url, api_token, …])

Returns an api.IBC or api.CPM4 object depending on input arguments.

pycelonis.api.IBC(celonis_url, api_token, …)

Object used to connect to an IBC team.

pycelonis.api.CPM4(celonis_url, api_token, …)

Object used to connect to a Celonis Process Mining 4 server.

IBC Objects

pycelonis.objects_ibc.Analysis(celonis, …)

An IBC Analysis object

pycelonis.objects_ibc.Datamodel(parent, …)

A datamodel in the IBC.

pycelonis.objects_ibc.DatamodelTable(parent, …)

A table in an IBC datamodel.

pycelonis.objects_ibc.DatamodelProcessConfiguration(…)

The process configuration of the datamodel.

pycelonis.objects_ibc.Pool(celonis, …)

A data pool in the IBC.

pycelonis.objects_ibc.DataConnection(parent, …)

A Data Connection in the IBC.

pycelonis.objects_ibc.DataJob(parent, id_or_data)

pycelonis.objects_ibc.PoolParameter(parent, …)

pycelonis.objects_ibc.Transformation(parent, …)

pycelonis.objects_ibc.Workspace(celonis, …)

IBC Workspace object

CPM4 Objects

pycelonis.objects_cpm4.Analysis(celonis, …)

A CPM4 Analysis object

pycelonis.objects_cpm4.Datamodel(celonis, …)

A datamodel in CPM4.

pycelonis.objects_cpm4.DatamodelTable(…)

A table in a CPM4 datamodel.

pycelonis.objects_cpm4.DatamodelColumn(…)

pycelonis.objects_cpm4.DatamodelProcessConfiguration(parent)

pycelonis.objects_cpm4.DBConnection(parent, …)

A database connection in CPM4.

pycelonis.objects_cpm4.DBConnectionTable(…)

A table in a database connection in CPM4.

pycelonis.objects_cpm4.Folder(celonis, …)

A CPM4 folder that can contain analyses and/or further folders.

Common objects

pycelonis.objects_base.BaseAnalysis(celonis, …)

pycelonis.objects_base.BaseAnalysisDocument(parent)

pycelonis.objects_base.BasePublishedDocument(parent)

Analysis published document containing the published state of an analysis

pycelonis.objects_base.BaseDraftDocument(parent)

Analysis draft object containing the draft state of an analysis

pycelonis.objects_base.BaseAnalysisSheet(…)

A sheet of an analysis document.

pycelonis.objects_base.BaseAnalysisComponent(…)

A components of a sheet of an analysis.

pycelonis.objects_base.BaseAnalysisSavedFormula(…)

A saved formula of an analysis.

pycelonis.objects_base.BaseAnalysisImage(…)

An image uploaded to an Analysis.

pycelonis.objects_base.BaseDatamodel(…)

pycelonis.objects_base.BaseDatamodelTable(…)

pycelonis.objects_base.CelonisAPIObject(…)

Represents an object in Celonis with its own endpoint and without a parent object.

pycelonis.objects_base.CelonisDataObject(…)

Represents an object in Celonis that only exists as data of a parent object.

pycelonis.objects_base.CelonisAPIChildObject(…)

Same as CelonisAPIObject except it has a parent object.

PQL Queries

pycelonis.pql

Classes to work with PQL queries

Utils

pycelonis.utils.api_utils

Utilities to work with API objects.

pycelonis.utils.parquet_utils

Utilities to work with parquet files for the IBC and CPM4.