celonis_api_objects.py
CelonisApiObject (CelonisDataObject)
¶
Implementation of CelonisDataObject
providing the Celonis API endpoint and storing the response data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
celonis |
Celonis |
Base object to interact with Celonis Execution Management System (EMS) API. |
required |
id_or_data |
Union[str, Dict] |
ID or data of the Celonis resource object. |
required |
static |
bool |
|
False |
url: str
property
readonly
¶
Absolut URL pointing to a Celonis resource via Celonis API.
name: str
inherited
property
writable
¶
Name of the object via data['name']
if available.
data
property
writable
¶
Response data from the Celonis API.
If static
is set to False
, every time you set the data
property will execute a POST
request to
the resource API endpoint to update the remote resource in Celonis EMS.
Examples:
o = celonis.<api-service>.find("<name or ID")
# This will execute a `POST` request to '<celonis_url>/<api-service>/api/...'
o.data["name"] = "New Name"
key: str
inherited
property
writable
¶
Key of the object via data['key']
if available.
reset_state(self)
¶
Resets data = None
.
This will force a reload of the remote resource from Celonis EMS on the next property access.
delete(self)
¶
Executes a DELETE
request to the resource API endpoint to delete the remote resource in Celonis EMS.
CelonisApiObjectChild (CelonisApiObject)
¶
Implementation of CelonisApiObject
to model hierarchical structure.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
parent |
Union[celonis_api.base_objects.celonis_api_objects.CelonisApiObject, str] |
The parent object. Can be an object of the class of the parent or the ID of the parent object. |
required |
id_or_data |
Union[str, Dict] |
ID or data of the Celonis resource object. |
required |
celonis |
Celonis |
Base object to interact with Celonis Execution Management System (EMS) API. |
None |
url: str
inherited
property
readonly
¶
Absolut URL pointing to a Celonis resource via Celonis API.
name: str
inherited
property
writable
¶
Name of the object via data['name']
if available.
data
inherited
property
writable
¶
Response data from the Celonis API.
If static
is set to False
, every time you set the data
property will execute a POST
request to
the resource API endpoint to update the remote resource in Celonis EMS.
Examples:
o = celonis.<api-service>.find("<name or ID")
# This will execute a `POST` request to '<celonis_url>/<api-service>/api/...'
o.data["name"] = "New Name"
key: str
inherited
property
writable
¶
Key of the object via data['key']
if available.
reset_state(self)
inherited
¶
Resets data = None
.
This will force a reload of the remote resource from Celonis EMS on the next property access.
delete(self)
inherited
¶
Executes a DELETE
request to the resource API endpoint to delete the remote resource in Celonis EMS.