Index

Module to interact with content nodes.

This module contains class to interact with a content node in EMS Studio.

Typical usage example

package = space.get_package(package_id)
folder = package.create_folder("FOLDER_NAME")
package.get_folder(folder.id)
package.publish(version="1.0.0")

AssetType

Bases: enum.Enum

Enum class for different asset types available within Studio.

ANALYSIS class-attribute

ANALYSIS = 'ANALYSIS'

SEMANTIC_MODEL class-attribute

SEMANTIC_MODEL = 'SEMANTIC_MODEL'

SCENARIO class-attribute

SCENARIO = 'SCENARIO'

BOARD class-attribute

BOARD = 'BOARD'

SKILL class-attribute

SKILL = 'SKILL'

SIMULATION_ASSET class-attribute

SIMULATION_ASSET = 'simulation-asset'

ContentNode

Bases: ContentNodeTransport

Content node object to interact with content node specific studio endpoints.

client class-attribute

client: Client = Field(Ellipsis, exclude=True)

id class-attribute

id: str

key class-attribute

key: str

space_id class-attribute

space_id: str

root_with_key class-attribute

root_with_key: str

from_transport classmethod

from_transport(client, content_node_transport)

Creates high-level content node object from given ContentNodeTransport.

Parameters:

• client (Client) –

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

• content_node_transport (ContentNodeTransport) –

  ContentNodeTransport object containing properties of content node.

Returns:

• ContentNode –

  A ContentNode object with properties from transport and given client.

update

update()

Pushes local changes of content node to EMS and updates properties with response from EMS.

sync

sync()

Syncs content node properties with EMS.

delete

delete()

Deletes content node.

is_package staticmethod

is_package(content_node_transport)

Returns whether content node transport is package.

is_folder staticmethod

is_folder(content_node_transport)

Returns whether content node transport is folder.

is_analysis staticmethod

is_analysis(content_node_transport)

Returns whether content node transport is analysis.

is_knowledge_model staticmethod

is_knowledge_model(content_node_transport)

Returns whether content node transport is knowledge model.

is_action_flow staticmethod

is_action_flow(content_node_transport)

Returns whether content node transport is action flow.

is_view staticmethod

is_view(content_node_transport)

Returns whether content node transport is view.

is_simulation staticmethod

is_simulation(content_node_transport)

Returns whether content node transport is simulation.

is_skill staticmethod

is_skill(content_node_transport)

Returns whether content node transport is skill.