service

ContentNodeType

Bases: Enum

ASSET class-attribute

ASSET = 'ASSET'

PACKAGE class-attribute

PACKAGE = 'PACKAGE'

FOLDER class-attribute

FOLDER = 'FOLDER'

IMAGE class-attribute

IMAGE = 'IMAGE'

RelationType

Bases: Enum

USES class-attribute

USES = 'USES'

DEPENDS_ON class-attribute

DEPENDS_ON = 'DEPENDS_ON'

ExceptionReference

Bases: PyCelonisBaseModel

reference class-attribute

reference: typing.Optional[str] = Field(alias='reference')

message class-attribute

message: typing.Optional[str] = Field(alias='message')

short_message class-attribute

short_message: typing.Optional[str] = Field(
    alias="shortMessage"
)

ValidationError

Bases: PyCelonisBaseModel

attribute class-attribute

attribute: typing.Optional[str] = Field(alias='attribute')

error class-attribute

error: typing.Optional[str] = Field(alias='error')

error_code class-attribute

error_code: typing.Optional[str] = Field(alias='errorCode')

additional_info class-attribute

additional_info: typing.Optional[str] = Field(
    alias="additionalInfo"
)

ValidationExceptionDescriptor

Bases: PyCelonisBaseModel

errors class-attribute

errors: typing.Optional[
    typing.List[ValidationError]
] = Field(alias="errors")

SpaceSaveTransport

Bases: PyCelonisBaseModel

permissions class-attribute

permissions: typing.Optional[typing.List[str]] = Field(
    alias="permissions"
)

id class-attribute

id: typing.Optional[str] = Field(alias='id')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

icon_reference class-attribute

icon_reference: typing.Optional[str] = Field(
    alias="iconReference"
)

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

SpaceTransport

Bases: PyCelonisBaseModel

permissions class-attribute

permissions: typing.Optional[typing.List[str]] = Field(
    alias="permissions"
)

id class-attribute

id: typing.Optional[str] = Field(alias='id')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

icon_reference class-attribute

icon_reference: typing.Optional[str] = Field(
    alias="iconReference"
)

creation_date class-attribute

creation_date: typing.Optional[datetime] = Field(
    alias="creationDate"
)

change_date class-attribute

change_date: typing.Optional[datetime] = Field(
    alias="changeDate"
)

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

AssetMetadataTransport

Bases: PyCelonisBaseModel

used_variables class-attribute

used_variables: typing.Optional[
    typing.List[VariableDefinition]
] = Field(alias="usedVariables")

related_assets class-attribute

related_assets: typing.Optional[
    typing.List[RelatedAsset]
] = Field(alias="relatedAssets")

asset_usages class-attribute

asset_usages: typing.Optional[
    typing.List[AssetUsage]
] = Field(alias="assetUsages")

metadata class-attribute

metadata: typing.Optional[JsonNode] = Field(
    alias="metadata"
)

hidden class-attribute

hidden: typing.Optional[bool] = Field(alias='hidden')

AssetUsage

Bases: PyCelonisBaseModel

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

target_objects class-attribute

target_objects: typing.Optional[
    typing.List[TargetUsageMetadata]
] = Field(alias="targetObjects")

ContentNodeBaseTransport

Bases: PyCelonisBaseModel

reference class-attribute

reference: typing.Optional[str] = Field(alias='reference')

version class-attribute

version: typing.Optional[str] = Field(alias='version')

external class-attribute

external: typing.Optional[bool] = Field(alias='external')

JsonNode

Bases: PyCelonisBaseModel

RelatedAsset

Bases: PyCelonisBaseModel

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

type_ class-attribute

type_: typing.Optional[str] = Field(alias='type')

relation_type class-attribute

relation_type: typing.Optional[RelationType] = Field(
    alias="relationType"
)

SaveContentNodeTransport

Bases: PyCelonisBaseModel

permissions class-attribute

permissions: typing.Optional[typing.List[str]] = Field(
    alias="permissions"
)

tenant_id class-attribute

tenant_id: typing.Optional[str] = Field(alias='tenantId')

id class-attribute

id: typing.Optional[str] = Field(alias='id')

key class-attribute

key: typing.Optional[str] = Field(alias='key')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

root_node_key class-attribute

root_node_key: typing.Optional[str] = Field(
    alias="rootNodeKey"
)

base class-attribute

base: typing.Optional[ContentNodeBaseTransport] = Field(
    alias="base"
)

asset_type class-attribute

asset_type: typing.Optional[str] = Field(alias='assetType')

node_type class-attribute

node_type: typing.Optional[ContentNodeType] = Field(
    alias="nodeType"
)

parent_node_key class-attribute

parent_node_key: typing.Optional[str] = Field(
    alias="parentNodeKey"
)

parent_node_id class-attribute

parent_node_id: typing.Optional[str] = Field(
    alias="parentNodeId"
)

invalid_content class-attribute

invalid_content: typing.Optional[bool] = Field(
    alias="invalidContent"
)

serialized_content class-attribute

serialized_content: typing.Optional[str] = Field(
    alias="serializedContent"
)

serialization_type class-attribute

serialization_type: typing.Optional[str] = Field(
    alias="serializationType"
)

draft_id class-attribute

draft_id: typing.Optional[str] = Field(alias='draftId')

working_draft_id class-attribute

working_draft_id: typing.Optional[str] = Field(
    alias="workingDraftId"
)

activated_draft_id class-attribute

activated_draft_id: typing.Optional[str] = Field(
    alias="activatedDraftId"
)

show_in_viewer_mode class-attribute

show_in_viewer_mode: typing.Optional[bool] = Field(
    alias="showInViewerMode"
)

public_available class-attribute

public_available: typing.Optional[bool] = Field(
    alias="publicAvailable"
)

embeddable class-attribute

embeddable: typing.Optional[bool] = Field(
    alias="embeddable"
)

root_node_id class-attribute

root_node_id: typing.Optional[str] = Field(
    alias="rootNodeId"
)

order class-attribute

order: typing.Optional[int] = Field(alias='order')

source class-attribute

source: typing.Optional[str] = Field(alias='source')

asset_metadata_transport class-attribute

asset_metadata_transport: typing.Optional[
    AssetMetadataTransport
] = Field(alias="assetMetadataTransport")

space_id class-attribute

space_id: typing.Optional[str] = Field(alias='spaceId')

change_date class-attribute

change_date: typing.Optional[datetime] = Field(
    alias="changeDate"
)

created_by_id class-attribute

created_by_id: typing.Optional[str] = Field(
    alias="createdById"
)

creation_date class-attribute

creation_date: typing.Optional[datetime] = Field(
    alias="creationDate"
)

created_by_name class-attribute

created_by_name: typing.Optional[str] = Field(
    alias="createdByName"
)

updated_by class-attribute

updated_by: typing.Optional[str] = Field(alias='updatedBy')

publish class-attribute

publish: typing.Optional[bool] = Field(alias='publish')

activate class-attribute

activate: typing.Optional[bool] = Field(alias='activate')

version class-attribute

version: typing.Optional[str] = Field(alias='version')

root class-attribute

root: typing.Optional[bool] = Field(alias='root')

asset class-attribute

asset: typing.Optional[bool] = Field(alias='asset')

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

root_with_key class-attribute

root_with_key: typing.Optional[str] = Field(
    alias="rootWithKey"
)

identifier class-attribute

identifier: typing.Optional[str] = Field(alias="identifier")

SourceUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute

id: typing.Optional[str] = Field(alias='id')

TargetUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute

id: typing.Optional[str] = Field(alias='id')

type_ class-attribute

type_: typing.Optional[str] = Field(alias='type')

source_objects class-attribute

source_objects: typing.Optional[
    typing.List[SourceUsageMetadata]
] = Field(alias="sourceObjects")

VariableDefinition

Bases: PyCelonisBaseModel

key class-attribute

key: typing.Optional[str] = Field(alias='key')

type_ class-attribute

type_: typing.Optional[str] = Field(alias='type')

description class-attribute

description: typing.Optional[str] = Field(
    alias="description"
)

source class-attribute

source: typing.Optional[str] = Field(alias='source')

runtime class-attribute

runtime: typing.Optional[bool] = Field(alias='runtime')

metadata class-attribute

metadata: typing.Optional[JsonNode] = Field(
    alias="metadata"
)

ContentNodeTransport

Bases: PyCelonisBaseModel

permissions class-attribute

permissions: typing.Optional[typing.List[str]] = Field(
    alias="permissions"
)

tenant_id class-attribute

tenant_id: typing.Optional[str] = Field(alias='tenantId')

id class-attribute

id: typing.Optional[str] = Field(alias='id')

key class-attribute

key: typing.Optional[str] = Field(alias='key')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

root_node_key class-attribute

root_node_key: typing.Optional[str] = Field(
    alias="rootNodeKey"
)

base class-attribute

base: typing.Optional[ContentNodeBaseTransport] = Field(
    alias="base"
)

asset_type class-attribute

asset_type: typing.Optional[str] = Field(alias='assetType')

node_type class-attribute

node_type: typing.Optional[ContentNodeType] = Field(
    alias="nodeType"
)

parent_node_key class-attribute

parent_node_key: typing.Optional[str] = Field(
    alias="parentNodeKey"
)

parent_node_id class-attribute

parent_node_id: typing.Optional[str] = Field(
    alias="parentNodeId"
)

invalid_content class-attribute

invalid_content: typing.Optional[bool] = Field(
    alias="invalidContent"
)

serialized_content class-attribute

serialized_content: typing.Optional[str] = Field(
    alias="serializedContent"
)

serialization_type class-attribute

serialization_type: typing.Optional[str] = Field(
    alias="serializationType"
)

draft_id class-attribute

draft_id: typing.Optional[str] = Field(alias='draftId')

working_draft_id class-attribute

working_draft_id: typing.Optional[str] = Field(
    alias="workingDraftId"
)

activated_draft_id class-attribute

activated_draft_id: typing.Optional[str] = Field(
    alias="activatedDraftId"
)

show_in_viewer_mode class-attribute

show_in_viewer_mode: typing.Optional[bool] = Field(
    alias="showInViewerMode"
)

public_available class-attribute

public_available: typing.Optional[bool] = Field(
    alias="publicAvailable"
)

embeddable class-attribute

embeddable: typing.Optional[bool] = Field(
    alias="embeddable"
)

root_node_id class-attribute

root_node_id: typing.Optional[str] = Field(
    alias="rootNodeId"
)

order class-attribute

order: typing.Optional[int] = Field(alias='order')

source class-attribute

source: typing.Optional[str] = Field(alias='source')

asset_metadata_transport class-attribute

asset_metadata_transport: typing.Optional[
    AssetMetadataTransport
] = Field(alias="assetMetadataTransport")

space_id class-attribute

space_id: typing.Optional[str] = Field(alias='spaceId')

change_date class-attribute

change_date: typing.Optional[datetime] = Field(
    alias="changeDate"
)

created_by_id class-attribute

created_by_id: typing.Optional[str] = Field(
    alias="createdById"
)

creation_date class-attribute

creation_date: typing.Optional[datetime] = Field(
    alias="creationDate"
)

created_by_name class-attribute

created_by_name: typing.Optional[str] = Field(
    alias="createdByName"
)

updated_by class-attribute

updated_by: typing.Optional[str] = Field(alias='updatedBy')

root class-attribute

root: typing.Optional[bool] = Field(alias='root')

asset class-attribute

asset: typing.Optional[bool] = Field(alias='asset')

object_id class-attribute

object_id: typing.Optional[str] = Field(alias='objectId')

root_with_key class-attribute

root_with_key: typing.Optional[str] = Field(
    alias="rootWithKey"
)

identifier class-attribute

identifier: typing.Optional[str] = Field(alias="identifier")

VariableDefinitionWithValue

Bases: PyCelonisBaseModel

key class-attribute

key: typing.Optional[str] = Field(alias='key')

type_ class-attribute

type_: typing.Optional[str] = Field(alias='type')

description class-attribute

description: typing.Optional[str] = Field(
    alias="description"
)

source class-attribute

source: typing.Optional[str] = Field(alias='source')

runtime class-attribute

runtime: typing.Optional[bool] = Field(alias='runtime')

metadata class-attribute

metadata: typing.Optional[JsonNode] = Field(
    alias="metadata"
)

value class-attribute

value: typing.Optional[typing.Any] = Field(alias='value')

SpaceDeleteTransport

Bases: PyCelonisBaseModel

id class-attribute

id: typing.Optional[str] = Field(alias='id')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

ActivatePackageTransport

Bases: PyCelonisBaseModel

package_key class-attribute

package_key: typing.Optional[str] = Field(
    alias="packageKey"
)

version class-attribute

version: typing.Optional[str] = Field(alias='version')

node_ids_to_exclude class-attribute

node_ids_to_exclude: typing.Optional[
    typing.List[str]
] = Field(alias="nodeIdsToExclude")

PackageVersionTransport

Bases: PyCelonisBaseModel

package_key class-attribute

package_key: typing.Optional[str] = Field(
    alias="packageKey"
)

version class-attribute

version: typing.Optional[str] = Field(alias='version')

root_draft_id class-attribute

root_draft_id: typing.Optional[str] = Field(
    alias="rootDraftId"
)

PackageDeleteTransport

Bases: PyCelonisBaseModel

id class-attribute

id: typing.Optional[str] = Field(alias='id')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

PackageHistoryTransport

Bases: PyCelonisBaseModel

id class-attribute

id: typing.Optional[str] = Field(alias='id')

key class-attribute

key: typing.Optional[str] = Field(alias='key')

name class-attribute

name: typing.Optional[str] = Field(alias='name')

version class-attribute

version: typing.Optional[str] = Field(alias='version')

date class-attribute

date: typing.Optional[datetime] = Field(alias='date')

active class-attribute

active: typing.Optional[bool] = Field(alias='active')

author_id class-attribute

author_id: typing.Optional[str] = Field(alias='authorId')

author_name class-attribute

author_name: typing.Optional[str] = Field(
    alias="authorName"
)

draft_id class-attribute

draft_id: typing.Optional[str] = Field(alias='draftId')

PackageManagerService

get_api_spaces_id staticmethod

get_api_spaces_id(client, id)

put_api_spaces_id staticmethod

put_api_spaces_id(client, id, request_body)

get_api_nodes_id staticmethod

get_api_nodes_id(client, id, draft_id=None)

put_api_nodes_id staticmethod

put_api_nodes_id(client, id, request_body)

delete_api_nodes_id staticmethod

delete_api_nodes_id(client, id)

put_api_nodes_by_package_key_package_key_variables_key staticmethod

put_api_nodes_by_package_key_package_key_variables_key(
    client, package_key, key, request_body
)

delete_api_nodes_by_package_key_package_key_variables_key staticmethod

delete_api_nodes_by_package_key_package_key_variables_key(
    client, package_key, key
)

get_api_spaces staticmethod

get_api_spaces(client)

post_api_spaces staticmethod

post_api_spaces(client, request_body)

post_api_spaces_delete_id staticmethod

post_api_spaces_delete_id(client, id, request_body)

post_api_packages_key_activate staticmethod

post_api_packages_key_activate(client, key, request_body)

post_api_packages_id_load_version staticmethod

post_api_packages_id_load_version(client, id, request_body)

post_api_packages_delete_id staticmethod

post_api_packages_delete_id(client, id, request_body)

post_api_nodes staticmethod

post_api_nodes(client, request_body)

post_api_nodes_by_package_key_package_key_variables staticmethod

post_api_nodes_by_package_key_package_key_variables(
    client, package_key, request_body
)

get_api_packages_id_next_version staticmethod

get_api_packages_id_next_version(client, id)

get_api_packages_id_history staticmethod

get_api_packages_id_history(client, id)

get_api_nodes_tree staticmethod

get_api_nodes_tree(client, space_id=None)

get_api_nodes_by_root_key_root_key staticmethod

get_api_nodes_by_root_key_root_key(
    client, root_key, asset_type=None, node_type=None
)

get_api_nodes_by_package_key_package_key_variables_definitions_with_values staticmethod

get_api_nodes_by_package_key_package_key_variables_definitions_with_values(
    client, package_key, type_=None, app_mode=None
)

get_api_final_nodes staticmethod

get_api_final_nodes(client, space_id=None)

get_api_final_nodes_id staticmethod

get_api_final_nodes_id(client, id, is_draft=None)