package

Module to interact with Packages.

This module contains class to interact with Packages in Apps.

PublishedPackage

Bases: PublishedContentNode

PublishedPackage object to interact with package specific apps endpoints.

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

name class-attribute instance-attribute

name = Field(alias='name')

root_node_key class-attribute instance-attribute

root_node_key = Field(alias='rootNodeKey')

base class-attribute instance-attribute

base = Field(alias='base')

asset_type class-attribute instance-attribute

asset_type = Field(alias='assetType')

node_type class-attribute instance-attribute

node_type = Field(alias='nodeType')

parent_node_key class-attribute instance-attribute

parent_node_key = Field(alias='parentNodeKey')

parent_node_id class-attribute instance-attribute

parent_node_id = Field(alias='parentNodeId')

invalid_content class-attribute instance-attribute

invalid_content = Field(alias='invalidContent')

serialized_content instance-attribute

serialized_content

Serialized content of content node.

serialization_type class-attribute instance-attribute

serialization_type = Field(alias='serializationType')

draft_id class-attribute instance-attribute

draft_id = Field(alias='draftId')

working_draft_id class-attribute instance-attribute

working_draft_id = Field(alias='workingDraftId')

activated_draft_id class-attribute instance-attribute

activated_draft_id = Field(alias='activatedDraftId')

show_in_viewer_mode class-attribute instance-attribute

show_in_viewer_mode = Field(alias='showInViewerMode')

public_available class-attribute instance-attribute

public_available = Field(alias='publicAvailable')

embeddable class-attribute instance-attribute

embeddable = Field(alias='embeddable')

root_node_id class-attribute instance-attribute

root_node_id = Field(alias='rootNodeId')

order class-attribute instance-attribute

order = Field(alias='order')

source class-attribute instance-attribute

source = Field(alias='source')

asset_metadata_transport class-attribute instance-attribute

asset_metadata_transport = Field(
    alias="assetMetadataTransport"
)

change_date class-attribute instance-attribute

change_date = Field(alias='changeDate')

created_by_id class-attribute instance-attribute

created_by_id = Field(alias='createdById')

creation_date class-attribute instance-attribute

creation_date = Field(alias='creationDate')

created_by_name class-attribute instance-attribute

created_by_name = Field(alias='createdByName')

updated_by class-attribute instance-attribute

updated_by = Field(alias='updatedBy')

root class-attribute instance-attribute

root = Field(alias='root')

asset class-attribute instance-attribute

asset = Field(alias='asset')

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

root_with_key class-attribute instance-attribute

root_with_key = Field(alias='rootWithKey')

identifier class-attribute instance-attribute

identifier = Field(alias='identifier')

client class-attribute instance-attribute

client = Field(..., exclude=True)

id instance-attribute

id

Id of package.

key instance-attribute

key

Key of package.

space_id instance-attribute

space_id

Id of space where package is located.

from_transport classmethod

from_transport(client, content_node_transport)

Creates high-level published content node object from given ContentNodeTransport.

Parameters:

• client (Client) –

  Client to use to make API calls for given published content node.

• content_node_transport (ContentNodeTransport) –

  ContentNodeTransport object containing properties of published content node.

Returns:

• PublishedContentNode –

  A PublishedContentNode object with properties from transport and given client.

sync

sync()

Syncs package properties with EMS.

get_content_node

get_content_node(id_)

Gets published content node located in package with given id.

Parameters:

• id_ (str) –

  Id of published content node.

Returns:

• PublishedContentNode –

  A PublishedContentNode object for published content node with given id.

Raises:

• PyCelonisNotFoundError –

  No published content node with given id located in package

get_content_nodes

get_content_nodes(asset_type=None, node_type=None)

Gets all published content nodes of given package.

Returns:

• CelonisCollection[PublishedContentNode] –

  A list containing all published content nodes.

get_analysis

get_analysis(id_)

Gets analysis of given package.

Parameters:

• id_ (str) –

  Id of analysis.

Returns:

• PublishedAnalysis –

  Analysis with given id.

get_analyses

get_analyses()

Gets all analyses of given package.

Returns:

• CelonisCollection[PublishedAnalysis] –

  A list containing all analyses.

get_folder

get_folder(id_)

Get folder of given package.

Parameters:

• id_ (str) –

  Id of folder.

Returns:

• PublishedFolder –

  Folder with given id.

get_folders

get_folders()

Get all folders of given package.

Returns:

• CelonisCollection[PublishedFolder] –

  A list containing all folders.

get_simulation

get_simulation(id_)

Gets simulation of given package.

Parameters:

• id_ (str) –

  Id of simulation.

Returns:

• PublishedSimulation –

  Simulation with given id.

get_simulations

get_simulations()

Gets all simulations of given package.

Returns:

• CelonisCollection[PublishedSimulation] –

  A list containing all simulations.

get_view

get_view(id_)

Gets view of given package.

Parameters:

• id_ (str) –

  Id of view.

Returns:

• PublishedView –

  View with given id.

get_views

get_views()

Gets all views of given package.

Returns:

• CelonisCollection[PublishedView] –

  A list containing all views.