Skip to content

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.

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 [VIEWER, CREATOR]

'CREATOR'

Returns:

Type Description
Attachment

The newly created Attachment.

Node (BaseNode, CelonisApiObjectChild)

Node object to interact with Celonis Studio API.