Skip to content

service

JsonNode module-attribute

JsonNode = Any

ContentNodeType

Bases: PyCelonisBaseEnum

ASSET class-attribute instance-attribute

ASSET = 'ASSET'

PACKAGE class-attribute instance-attribute

PACKAGE = 'PACKAGE'

FOLDER class-attribute instance-attribute

FOLDER = 'FOLDER'

IMAGE class-attribute instance-attribute

IMAGE = 'IMAGE'

RelationType

Bases: PyCelonisBaseEnum

USES class-attribute instance-attribute

USES = 'USES'

DEPENDS_ON class-attribute instance-attribute

DEPENDS_ON = 'DEPENDS_ON'

ExceptionReference

Bases: PyCelonisBaseModel

reference class-attribute instance-attribute

reference = Field(alias='reference')

message class-attribute instance-attribute

message = Field(alias='message')

short_message class-attribute instance-attribute

short_message = Field(alias='shortMessage')

ValidationError

Bases: PyCelonisBaseModel

attribute class-attribute instance-attribute

attribute = Field(alias='attribute')

error class-attribute instance-attribute

error = Field(alias='error')

error_code class-attribute instance-attribute

error_code = Field(alias='errorCode')

additional_info class-attribute instance-attribute

additional_info = Field(alias='additionalInfo')

ValidationExceptionDescriptor

Bases: PyCelonisBaseModel

errors class-attribute instance-attribute

errors = Field(alias='errors')

SpaceSaveTransport

Bases: PyCelonisBaseModel

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

id class-attribute instance-attribute

id = Field(alias='id')

name class-attribute instance-attribute

name = Field(alias='name')

icon_reference class-attribute instance-attribute

icon_reference = Field(alias='iconReference')

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

SpaceTransport

Bases: PyCelonisBaseModel

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

id class-attribute instance-attribute

id = Field(alias='id')

name class-attribute instance-attribute

name = Field(alias='name')

icon_reference class-attribute instance-attribute

icon_reference = Field(alias='iconReference')

creation_date class-attribute instance-attribute

creation_date = Field(alias='creationDate')

change_date class-attribute instance-attribute

change_date = Field(alias='changeDate')

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

AssetMetadataTransport

Bases: PyCelonisBaseModel

used_variables class-attribute instance-attribute

used_variables = Field(alias='usedVariables')

related_assets class-attribute instance-attribute

related_assets = Field(alias='relatedAssets')

asset_usages class-attribute instance-attribute

asset_usages = Field(alias='assetUsages')

metadata class-attribute instance-attribute

metadata = Field(alias='metadata')

hidden class-attribute instance-attribute

hidden = Field(alias='hidden')

AssetUsage

Bases: PyCelonisBaseModel

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

target_objects class-attribute instance-attribute

target_objects = Field(alias='targetObjects')

ContentNodeBaseTransport

Bases: PyCelonisBaseModel

reference class-attribute instance-attribute

reference = Field(alias='reference')

version class-attribute instance-attribute

version = Field(alias='version')

external class-attribute instance-attribute

external = Field(alias='external')

RelatedAsset

Bases: PyCelonisBaseModel

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

relation_type class-attribute instance-attribute

relation_type = Field(alias='relationType')

SaveContentNodeTransport

Bases: PyCelonisBaseModel

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

id class-attribute instance-attribute

id = Field(alias='id')

key class-attribute instance-attribute

key = Field(alias='key')

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 class-attribute instance-attribute

serialized_content = Field(alias='serializedContent')

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"
)

space_id class-attribute instance-attribute

space_id = Field(alias='spaceId')

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')

publish class-attribute instance-attribute

publish = Field(alias='publish')

activate class-attribute instance-attribute

activate = Field(alias='activate')

version class-attribute instance-attribute

version = Field(alias='version')

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')

SourceUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

TargetUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

source_objects class-attribute instance-attribute

source_objects = Field(alias='sourceObjects')

VariableDefinition

Bases: PyCelonisBaseModel

key class-attribute instance-attribute

key = Field(alias='key')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

description class-attribute instance-attribute

description = Field(alias='description')

source class-attribute instance-attribute

source = Field(alias='source')

runtime class-attribute instance-attribute

runtime = Field(alias='runtime')

metadata class-attribute instance-attribute

metadata = Field(alias='metadata')

ContentNodeTransport

Bases: PyCelonisBaseModel

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

id class-attribute instance-attribute

id = Field(alias='id')

key class-attribute instance-attribute

key = Field(alias='key')

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 class-attribute instance-attribute

serialized_content = Field(alias='serializedContent')

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"
)

space_id class-attribute instance-attribute

space_id = Field(alias='spaceId')

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')

VariableDefinitionWithValue

Bases: PyCelonisBaseModel

key class-attribute instance-attribute

key = Field(alias='key')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

description class-attribute instance-attribute

description = Field(alias='description')

source class-attribute instance-attribute

source = Field(alias='source')

runtime class-attribute instance-attribute

runtime = Field(alias='runtime')

metadata class-attribute instance-attribute

metadata = Field(alias='metadata')

value class-attribute instance-attribute

value = Field(alias='value')

SpaceDeleteTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

name class-attribute instance-attribute

name = Field(alias='name')

ActivatePackageTransport

Bases: PyCelonisBaseModel

package_key class-attribute instance-attribute

package_key = Field(alias='packageKey')

version class-attribute instance-attribute

version = Field(alias='version')

node_ids_to_exclude class-attribute instance-attribute

node_ids_to_exclude = Field(alias='nodeIdsToExclude')

PackageVersionTransport

Bases: PyCelonisBaseModel

package_key class-attribute instance-attribute

package_key = Field(alias='packageKey')

version class-attribute instance-attribute

version = Field(alias='version')

root_draft_id class-attribute instance-attribute

root_draft_id = Field(alias='rootDraftId')

PackageDeleteTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

name class-attribute instance-attribute

name = Field(alias='name')

PackageHistoryTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

key class-attribute instance-attribute

key = Field(alias='key')

name class-attribute instance-attribute

name = Field(alias='name')

version class-attribute instance-attribute

version = Field(alias='version')

date class-attribute instance-attribute

date = Field(alias='date')

active class-attribute instance-attribute

active = Field(alias='active')

author_id class-attribute instance-attribute

author_id = Field(alias='authorId')

author_name class-attribute instance-attribute

author_name = Field(alias='authorName')

draft_id class-attribute instance-attribute

draft_id = 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)