service

JsonNode module-attribute

JsonNode = Any

BoardAssetType

Bases: PyCelonisBaseEnum

BOARD class-attribute instance-attribute

BOARD = 'BOARD'

BOARD_V2 class-attribute instance-attribute

BOARD_V2 = 'BOARD_V2'

InputDataType

Bases: PyCelonisBaseEnum

TEXT class-attribute instance-attribute

TEXT = 'TEXT'

NUMBER class-attribute instance-attribute

NUMBER = 'NUMBER'

BOOLEAN class-attribute instance-attribute

BOOLEAN = 'BOOLEAN'

PQL class-attribute instance-attribute

PQL = 'PQL'

LIST class-attribute instance-attribute

LIST = 'LIST'

DATE class-attribute instance-attribute

DATE = 'DATE'

OBJECT class-attribute instance-attribute

OBJECT = 'OBJECT'

InputScope

Bases: PyCelonisBaseEnum

USER_SPECIFIC class-attribute instance-attribute

USER_SPECIFIC = 'USER_SPECIFIC'

SYSTEM class-attribute instance-attribute

SYSTEM = 'SYSTEM'

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'

CascadeType

Bases: PyCelonisBaseEnum

DELETE class-attribute instance-attribute

DELETE = 'DELETE'

RelationType

Bases: PyCelonisBaseEnum

USES class-attribute instance-attribute

USES = 'USES'

DEPENDS_ON class-attribute instance-attribute

DEPENDS_ON = 'DEPENDS_ON'

BoardUpsertRequest

Bases: PyCelonisBaseModel

board_asset_type class-attribute instance-attribute

board_asset_type = Field(None, alias='boardAssetType')

configuration class-attribute instance-attribute

configuration = Field(None, alias='configuration')

id class-attribute instance-attribute

id = Field(None, alias='id')

input_variable_definitions class-attribute instance-attribute

input_variable_definitions = Field(
    None, alias="inputVariableDefinitions"
)

parent_node_id class-attribute instance-attribute

parent_node_id = Field(None, alias='parentNodeId')

parent_node_key class-attribute instance-attribute

parent_node_key = Field(None, alias='parentNodeKey')

root_node_key class-attribute instance-attribute

root_node_key = Field(None, alias='rootNodeKey')

InputVariableDefinitionTransport

Bases: PyCelonisBaseModel

data_type class-attribute instance-attribute

data_type = Field(None, alias='dataType')

default_value class-attribute instance-attribute

default_value = Field(None, alias='defaultValue')

description class-attribute instance-attribute

description = Field(None, alias='description')

display_name class-attribute instance-attribute

display_name = Field(None, alias='displayName')

key class-attribute instance-attribute

key = Field(None, alias='key')

propagate class-attribute instance-attribute

propagate = Field(None, alias='propagate')

scope class-attribute instance-attribute

scope = Field(None, alias='scope')

ExceptionReference

Bases: PyCelonisBaseModel

message class-attribute instance-attribute

message = Field(None, alias='message')

reference class-attribute instance-attribute

reference = Field(None, alias='reference')

short_message class-attribute instance-attribute

short_message = Field(None, alias='shortMessage')

ContentNodeTransport

Bases: PyCelonisBaseModel

activated_draft_id class-attribute instance-attribute

activated_draft_id = Field(None, alias='activatedDraftId')

asset class-attribute instance-attribute

asset = Field(None, alias='asset')

asset_metadata_transport class-attribute instance-attribute

asset_metadata_transport = Field(
    None, alias="assetMetadataTransport"
)

asset_type class-attribute instance-attribute

asset_type = Field(None, alias='assetType')

base class-attribute instance-attribute

base = Field(None, alias='base')

change_date class-attribute instance-attribute

change_date = Field(None, alias='changeDate')

created_by_id class-attribute instance-attribute

created_by_id = Field(None, alias='createdById')

creation_date class-attribute instance-attribute

creation_date = Field(None, alias='creationDate')

deleted_at class-attribute instance-attribute

deleted_at = Field(None, alias='deletedAt')

deleted_by class-attribute instance-attribute

deleted_by = Field(None, alias='deletedBy')

draft_id class-attribute instance-attribute

draft_id = Field(None, alias='draftId')

embeddable class-attribute instance-attribute

embeddable = Field(None, alias='embeddable')

id class-attribute instance-attribute

id = Field(None, alias='id')

identifier class-attribute instance-attribute

identifier = Field(None, alias='identifier')

input_variable_definitions class-attribute instance-attribute

input_variable_definitions = Field(
    None, alias="inputVariableDefinitions"
)

invalid_content class-attribute instance-attribute

invalid_content = Field(None, alias='invalidContent')

key class-attribute instance-attribute

key = Field(None, alias='key')

name class-attribute instance-attribute

name = Field(None, alias='name')

node_type class-attribute instance-attribute

node_type = Field(None, alias='nodeType')

object_id class-attribute instance-attribute

object_id = Field(None, alias='objectId')

order class-attribute instance-attribute

order = Field(None, alias='order')

parent_node_id class-attribute instance-attribute

parent_node_id = Field(None, alias='parentNodeId')

parent_node_key class-attribute instance-attribute

parent_node_key = Field(None, alias='parentNodeKey')

permissions class-attribute instance-attribute

permissions = Field(None, alias='permissions')

public_available class-attribute instance-attribute

public_available = Field(None, alias='publicAvailable')

root class-attribute instance-attribute

root = Field(None, alias='root')

root_node_id class-attribute instance-attribute

root_node_id = Field(None, alias='rootNodeId')

root_node_key class-attribute instance-attribute

root_node_key = Field(None, alias='rootNodeKey')

root_with_key class-attribute instance-attribute

root_with_key = Field(None, alias='rootWithKey')

schema_version class-attribute instance-attribute

schema_version = Field(None, alias='schemaVersion')

serialization_type class-attribute instance-attribute

serialization_type = Field(None, alias='serializationType')

serialized_content class-attribute instance-attribute

serialized_content = Field(None, alias='serializedContent')

show_in_viewer_mode class-attribute instance-attribute

show_in_viewer_mode = Field(None, alias='showInViewerMode')

source class-attribute instance-attribute

source = Field(None, alias='source')

space_id class-attribute instance-attribute

space_id = Field(None, alias='spaceId')

tenant_id class-attribute instance-attribute

tenant_id = Field(None, alias='tenantId')

updated_by class-attribute instance-attribute

updated_by = Field(None, alias='updatedBy')

working_draft_id class-attribute instance-attribute

working_draft_id = Field(None, alias='workingDraftId')

FrontendHandledBackendError

Bases: PyCelonisBaseModel

error_information class-attribute instance-attribute

error_information = Field(None, alias='errorInformation')

frontend_error_key class-attribute instance-attribute

frontend_error_key = Field(None, alias='frontendErrorKey')

AssetMetadataTransport

Bases: PyCelonisBaseModel

asset_usages class-attribute instance-attribute

asset_usages = Field(None, alias='assetUsages')

hidden class-attribute instance-attribute

hidden = Field(None, alias='hidden')

metadata class-attribute instance-attribute

metadata = Field(None, alias='metadata')

related_assets class-attribute instance-attribute

related_assets = Field(None, alias='relatedAssets')

used_variables class-attribute instance-attribute

used_variables = Field(None, alias='usedVariables')

AssetUsage

Bases: PyCelonisBaseModel

object_id class-attribute instance-attribute

object_id = Field(None, alias='objectId')

target_objects class-attribute instance-attribute

target_objects = Field(None, alias='targetObjects')

TargetUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(None, alias='id')

source_objects class-attribute instance-attribute

source_objects = Field(None, alias='sourceObjects')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

SourceUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(None, alias='id')

VariableDefinition

Bases: PyCelonisBaseModel

description class-attribute instance-attribute

description = Field(None, alias='description')

key class-attribute instance-attribute

key = Field(None, alias='key')

metadata class-attribute instance-attribute

metadata = Field(None, alias='metadata')

runtime class-attribute instance-attribute

runtime = Field(None, alias='runtime')

source class-attribute instance-attribute

source = Field(None, alias='source')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

ContentNodeBaseTransport

Bases: PyCelonisBaseModel

external class-attribute instance-attribute

external = Field(None, alias='external')

reference class-attribute instance-attribute

reference = Field(None, alias='reference')

version class-attribute instance-attribute

version = Field(None, alias='version')

RelatedAsset

Bases: PyCelonisBaseModel

cascade_type class-attribute instance-attribute

cascade_type = Field(None, alias='cascadeType')

object_id class-attribute instance-attribute

object_id = Field(None, alias='objectId')

relation_type class-attribute instance-attribute

relation_type = Field(None, alias='relationType')

type_ class-attribute instance-attribute

type_ = Field(None, alias='type')

Blueprint

post_api_boards staticmethod

post_api_boards(
    client,
    request_body,
    should_activate=None,
    should_publish=None,
    validate_=None,
    **kwargs
)

put_api_boards_board_id staticmethod

put_api_boards_board_id(
    client,
    board_id,
    request_body,
    should_activate=None,
    should_publish=None,
    validate_=None,
    **kwargs
)