folder.py

Folder (Node)

Folder object to interact with Celonis Studio API.

package_nodes_url: str property readonly

API

• /package-manager/api/nodes/by-root-id/{root_node_id}

url: str inherited property readonly

API

• /package-manager/api/nodes/{node_id}

nodes: CelonisCollection[Node] property readonly

Get all Nodes located in the Folder.

Returns:

Type	Description
CelonisCollection[Node]	A Collection of Nodes located in the Folder.

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.

knowledge_models: CelonisCollection[KnowledgeModel] property readonly

Get all Knowledge Models located in Folder.

Returns:

Type	Description
CelonisCollection[KnowledgeModel]	A Collection of Knowledge Models located in Folder

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.

analyses: CelonisCollection[Analysis] property readonly

Get all Analyses located in Folder.

Returns:

Type	Description
CelonisCollection[Analysis]	A Collection of Analysis located in Folder.

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.

views: CelonisCollection[View] property readonly

Get all Views located in Folder.

Returns:

Type	Description
CelonisCollection[View]	A Collection of Views located in Folder.

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.

skills: CelonisCollection[Skill] property readonly

Get all Skills located in Folder.

Returns:

Type	Description
CelonisCollection[Skill]	A Collection of Skills located in Folder.

folders: CelonisCollection[Folder] property readonly

Get all Folders located in Folder.

Returns:

Type	Description
CelonisCollection[Folder]	A Collection of Folders located in Folder.

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