node.py
BaseNode (CelonisApiObject)
¶
Base Node object to interact with Celonis Studio API.
url: str
property
readonly
¶
API
/package-manager/api/nodes/{node_id}
attachment_url: str
property
readonly
¶
API
/package-manager/api/attachments
viewer_attachments: CelonisCollection[Attachment]
property
readonly
¶
Get all Attachments of the Node with mode VIEWER.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
creator_attachments: CelonisCollection[Attachment]
property
readonly
¶
Get all Attachments of the Node with mode CREATOR.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
attachments: CelonisCollection[Attachment]
property
readonly
¶
Get all Attachments of the Node.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
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.
create_attachment(self, name, configuration, shareable=True, mode='CREATOR')
¶
Creates a new Attachment in the Node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str |
Name of attachment |
required |
configuration |
str |
Dictionary with content of attachment |
required |
shareable |
bool |
Whether attachment is shareable or not |
True |
mode |
str |
Attachment mode. One of [ |
'CREATOR' |
Returns:
| Type | Description |
|---|---|
Attachment |
The newly created Attachment. |
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.
Node (BaseNode, CelonisApiObjectChild)
¶
Node object to interact with Celonis Studio API.
url: str
inherited
property
readonly
¶
API
/package-manager/api/nodes/{node_id}
attachment_url: str
inherited
property
readonly
¶
API
/package-manager/api/attachments
viewer_attachments: CelonisCollection[Attachment]
inherited
property
readonly
¶
Get all Attachments of the Node with mode VIEWER.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
creator_attachments: CelonisCollection[Attachment]
inherited
property
readonly
¶
Get all Attachments of the Node with mode CREATOR.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
attachments: CelonisCollection[Attachment]
inherited
property
readonly
¶
Get all Attachments of the Node.
Returns:
| Type | Description |
|---|---|
CelonisCollection[Attachment] |
A Collection of Attachments. |
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.
create_attachment(self, name, configuration, shareable=True, mode='CREATOR')
inherited
¶
Creates a new Attachment in the Node.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str |
Name of attachment |
required |
configuration |
str |
Dictionary with content of attachment |
required |
shareable |
bool |
Whether attachment is shareable or not |
True |
mode |
str |
Attachment mode. One of [ |
'CREATOR' |
Returns:
| Type | Description |
|---|---|
Attachment |
The newly created Attachment. |
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.