service

JsonNode module-attribute

JsonNode = Any

CascadeType

Bases: PyCelonisBaseEnum

DELETE class-attribute instance-attribute

DELETE = 'DELETE'

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'

KpiDirection

Bases: PyCelonisBaseEnum

INCREASE class-attribute instance-attribute

INCREASE = 'INCREASE'

DECREASE class-attribute instance-attribute

DECREASE = 'DECREASE'

NEUTRAL class-attribute instance-attribute

NEUTRAL = 'NEUTRAL'

NONE class-attribute instance-attribute

NONE = 'NONE'

LayerKind

Bases: PyCelonisBaseEnum

BASE class-attribute instance-attribute

BASE = 'BASE'

EXTENSION class-attribute instance-attribute

EXTENSION = 'EXTENSION'

MetadataType

Bases: PyCelonisBaseEnum

KPI class-attribute instance-attribute

KPI = 'KPI'

RECORD class-attribute instance-attribute

RECORD = 'RECORD'

VARIABLE class-attribute instance-attribute

VARIABLE = 'VARIABLE'

ACTIVITY class-attribute instance-attribute

ACTIVITY = 'ACTIVITY'

FILTER class-attribute instance-attribute

FILTER = 'FILTER'

ACTION class-attribute instance-attribute

ACTION = 'ACTION'

ANOMALY class-attribute instance-attribute

ANOMALY = 'ANOMALY'

ATTRIBUTE class-attribute instance-attribute

ATTRIBUTE = 'ATTRIBUTE'

NEW_ATTRIBUTE class-attribute instance-attribute

NEW_ATTRIBUTE = 'NEW_ATTRIBUTE'

AUGMENTED_ATTRIBUTE class-attribute instance-attribute

AUGMENTED_ATTRIBUTE = 'AUGMENTED_ATTRIBUTE'

PRIORITY class-attribute instance-attribute

PRIORITY = 'PRIORITY'

FLAG class-attribute instance-attribute

FLAG = 'FLAG'

EVENT_LOG class-attribute instance-attribute

EVENT_LOG = 'EVENT_LOG'

DATA_TRIGGER class-attribute instance-attribute

DATA_TRIGGER = 'DATA_TRIGGER'

ParameterType

Bases: PyCelonisBaseEnum

VARIABLE class-attribute instance-attribute

VARIABLE = 'VARIABLE'

TABLE class-attribute instance-attribute

TABLE = 'TABLE'

INTEGER class-attribute instance-attribute

INTEGER = 'INTEGER'

TEXT class-attribute instance-attribute

TEXT = 'TEXT'

PQL class-attribute instance-attribute

PQL = 'PQL'

ScopeType

Bases: PyCelonisBaseEnum

DISABLED class-attribute instance-attribute

DISABLED = 'DISABLED'

TransitionType

Bases: PyCelonisBaseEnum

NON_INTERLEAVED class-attribute instance-attribute

NON_INTERLEAVED = 'NON_INTERLEAVED'

INTERLEAVED class-attribute instance-attribute

INTERLEAVED = 'INTERLEAVED'

ComputeCallerType

Bases: PyCelonisBaseEnum

PROCESS_WORKSPACE class-attribute instance-attribute

PROCESS_WORKSPACE = 'PROCESS_WORKSPACE'

KNOWLEDGE_MODEL class-attribute instance-attribute

KNOWLEDGE_MODEL = 'KNOWLEDGE_MODEL'

VIEW class-attribute instance-attribute

VIEW = 'VIEW'

DATA_MODEL class-attribute instance-attribute

DATA_MODEL = 'DATA_MODEL'

DataPermissionStrategy

Bases: PyCelonisBaseEnum

AND class-attribute instance-attribute

AND = 'AND'

OR class-attribute instance-attribute

OR = 'OR'

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

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

FrontendHandledBackendError

Bases: PyCelonisBaseModel

frontend_error_key class-attribute instance-attribute

frontend_error_key = Field(alias='frontendErrorKey')

error_information class-attribute instance-attribute

error_information = Field(alias='errorInformation')

FinalModelOptions

Bases: PyCelonisBaseModel

with_variable_replacement class-attribute instance-attribute

with_variable_replacement = Field(
    alias="withVariableReplacement"
)

with_autogenerated_data_model_data class-attribute instance-attribute

with_autogenerated_data_model_data = Field(
    alias="withAutogeneratedDataModelData"
)

with_default_values class-attribute instance-attribute

with_default_values = Field(alias='withDefaultValues')

validate_pql class-attribute instance-attribute

validate_pql = Field(alias='validatePql')

with_unknown_variables_validation class-attribute instance-attribute

with_unknown_variables_validation = Field(
    alias="withUnknownVariablesValidation"
)

with_resolved_scopes class-attribute instance-attribute

with_resolved_scopes = Field(alias='withResolvedScopes')

YamlMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

key class-attribute instance-attribute

key = Field(alias='key')

parent_node_id class-attribute instance-attribute

parent_node_id = Field(alias='parentNodeId')

final_model_options class-attribute instance-attribute

final_model_options = Field(alias='finalModelOptions')

content class-attribute instance-attribute

content = Field(alias='content')

visual_editor_validation class-attribute instance-attribute

visual_editor_validation = Field(
    alias="visualEditorValidation"
)

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

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

asset class-attribute instance-attribute

asset = Field(alias='asset')

root class-attribute instance-attribute

root = Field(alias='root')

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

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

cascade_type class-attribute instance-attribute

cascade_type = Field(alias='cascadeType')

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

ActionInput

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

attribute class-attribute instance-attribute

attribute = Field(alias='attribute')

ActionMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

skill_id class-attribute instance-attribute

skill_id = Field(alias='skillId')

skill_key class-attribute instance-attribute

skill_key = Field(alias='skillKey')

records class-attribute instance-attribute

records = Field(alias='records')

filters class-attribute instance-attribute

filters = Field(alias='filters')

inputs class-attribute instance-attribute

inputs = Field(alias='inputs')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

ActivityMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

value class-attribute instance-attribute

value = Field(alias='value')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

AlertMetric

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

pql class-attribute instance-attribute

pql = Field(alias='pql')

message class-attribute instance-attribute

message = Field(alias='message')

AnomalyKpiMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

kpi_id class-attribute instance-attribute

kpi_id = Field(alias='kpiId')

impact_calculation class-attribute instance-attribute

impact_calculation = Field(alias='impactCalculation')

scope class-attribute instance-attribute

scope = Field(alias='scope')

AnomalyMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

flag class-attribute instance-attribute

flag = Field(alias='flag')

kpi_ids class-attribute instance-attribute

kpi_ids = Field(alias='kpiIds')

kpis class-attribute instance-attribute

kpis = Field(alias='kpis')

mom_change class-attribute instance-attribute

mom_change = Field(alias='momChange')

knowledge_object_id class-attribute instance-attribute

knowledge_object_id = Field(alias='knowledgeObjectId')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

AttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

column_type class-attribute instance-attribute

column_type = Field(alias='columnType')

unit class-attribute instance-attribute

unit = Field(alias='unit')

format class-attribute instance-attribute

format = Field(alias='format')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

AugmentedAttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

possible_values class-attribute instance-attribute

possible_values = Field(alias='possibleValues')

default_value class-attribute instance-attribute

default_value = Field(alias='defaultValue')

column_type class-attribute instance-attribute

column_type = Field(alias='columnType')

pql class-attribute instance-attribute

pql = Field(alias='pql')

unit class-attribute instance-attribute

unit = Field(alias='unit')

format class-attribute instance-attribute

format = Field(alias='format')

housekeeping class-attribute instance-attribute

housekeeping = Field(alias='housekeeping')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

BaseMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

BusinessRecordMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

augmented class-attribute instance-attribute

augmented = Field(alias='augmented')

identifier class-attribute instance-attribute

identifier = Field(alias='identifier')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

attributes class-attribute instance-attribute

attributes = Field(alias='attributes')

new_attributes class-attribute instance-attribute

new_attributes = Field(alias='newAttributes')

augmented_attributes class-attribute instance-attribute

augmented_attributes = Field(alias='augmentedAttributes')

flags class-attribute instance-attribute

flags = Field(alias='flags')

priorities class-attribute instance-attribute

priorities = Field(alias='priorities')

data_triggers class-attribute instance-attribute

data_triggers = Field(alias='dataTriggers')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

DataTriggerMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

EventLogKpi

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

event_log_id class-attribute instance-attribute

event_log_id = Field(alias='eventLogId')

node_kpi_ids class-attribute instance-attribute

node_kpi_ids = Field(alias='nodeKpiIds')

edge_kpi_ids class-attribute instance-attribute

edge_kpi_ids = Field(alias='edgeKpiIds')

node_kpis class-attribute instance-attribute

node_kpis = Field(alias='nodeKpis')

edge_kpis class-attribute instance-attribute

edge_kpis = Field(alias='edgeKpis')

EventLogKpiView

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

icon class-attribute instance-attribute

icon = Field(alias='icon')

event_log_kpis class-attribute instance-attribute

event_log_kpis = Field(alias='eventLogKpis')

transition_kpis class-attribute instance-attribute

transition_kpis = Field(alias='transitionKpis')

EventLogMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

EventLogTransition

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

first_event_log_id class-attribute instance-attribute

first_event_log_id = Field(alias='firstEventLogId')

second_event_log_id class-attribute instance-attribute

second_event_log_id = Field(alias='secondEventLogId')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

EventLogTransitionKpi

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

transition_id class-attribute instance-attribute

transition_id = Field(alias='transitionId')

kpi_id class-attribute instance-attribute

kpi_id = Field(alias='kpiId')

FilterMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

global_ class-attribute instance-attribute

global_ = Field(alias='global')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

FinalLayerTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

layer class-attribute instance-attribute

layer = Field(alias='layer')

yaml_object class-attribute instance-attribute

yaml_object = Field(alias='yamlObject')

KpiBenchmarking

Bases: PyCelonisBaseModel

value class-attribute instance-attribute

value = Field(alias='value')

action class-attribute instance-attribute

action = Field(alias='action')

leading_bucket class-attribute instance-attribute

leading_bucket = Field(alias='leadingBucket')

exceeding_bucket class-attribute instance-attribute

exceeding_bucket = Field(alias='exceedingBucket')

achieving_bucket class-attribute instance-attribute

achieving_bucket = Field(alias='achievingBucket')

lagging_bucket class-attribute instance-attribute

lagging_bucket = Field(alias='laggingBucket')

KpiBenchmarkingAction

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

description class-attribute instance-attribute

description = Field(alias='description')

link class-attribute instance-attribute

link = Field(alias='link')

KpiMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

unit class-attribute instance-attribute

unit = Field(alias='unit')

format class-attribute instance-attribute

format = Field(alias='format')

breakdowns class-attribute instance-attribute

breakdowns = Field(alias='breakdowns')

aggregations class-attribute instance-attribute

aggregations = Field(alias='aggregations')

parameters class-attribute instance-attribute

parameters = Field(alias='parameters')

targets class-attribute instance-attribute

targets = Field(alias='targets')

desired_direction class-attribute instance-attribute

desired_direction = Field(alias='desiredDirection')

priority class-attribute instance-attribute

priority = Field(alias='priority')

benchmarking class-attribute instance-attribute

benchmarking = Field(alias='benchmarking')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

benchmarkable class-attribute instance-attribute

benchmarkable = Field(alias='benchmarkable')

KpiWithAlert

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

kpi_id class-attribute instance-attribute

kpi_id = Field(alias='kpiId')

icon class-attribute instance-attribute

icon = Field(alias='icon')

alert_metrics class-attribute instance-attribute

alert_metrics = Field(alias='alertMetrics')

LayerBase

Bases: PyCelonisBaseModel

key class-attribute instance-attribute

key = Field(alias='key')

version class-attribute instance-attribute

version = Field(alias='version')

app_store_based class-attribute instance-attribute

app_store_based = Field(alias='appStoreBased')

LayerMetadata

Bases: PyCelonisBaseModel

key class-attribute instance-attribute

key = Field(alias='key')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

version class-attribute instance-attribute

version = Field(alias='version')

LayerTransport

Bases: PyCelonisBaseModel

kind class-attribute instance-attribute

kind = Field(alias='kind')

metadata class-attribute instance-attribute

metadata = Field(alias='metadata')

base class-attribute instance-attribute

base = Field(alias='base')

data_model_id class-attribute instance-attribute

data_model_id = Field(alias='dataModelId')

records class-attribute instance-attribute

records = Field(alias='records')

kpis class-attribute instance-attribute

kpis = Field(alias='kpis')

filters class-attribute instance-attribute

filters = Field(alias='filters')

variables class-attribute instance-attribute

variables = Field(alias='variables')

activities class-attribute instance-attribute

activities = Field(alias='activities')

event_logs_metadata class-attribute instance-attribute

event_logs_metadata = Field(alias='eventLogsMetadata')

anomalies class-attribute instance-attribute

anomalies = Field(alias='anomalies')

event_logs class-attribute instance-attribute

event_logs = Field(alias='eventLogs')

custom_objects class-attribute instance-attribute

custom_objects = Field(alias='customObjects')

id class-attribute instance-attribute

id = Field(alias='id')

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

actions class-attribute instance-attribute

actions = Field(alias='actions')

node_entity_id class-attribute instance-attribute

node_entity_id = Field(alias='nodeEntityId')

NewAttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

possible_values class-attribute instance-attribute

possible_values = Field(alias='possibleValues')

default_value class-attribute instance-attribute

default_value = Field(alias='defaultValue')

column_type class-attribute instance-attribute

column_type = Field(alias='columnType')

unit class-attribute instance-attribute

unit = Field(alias='unit')

format class-attribute instance-attribute

format = Field(alias='format')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

NewEventLogMetadata

Bases: PyCelonisBaseModel

event_logs class-attribute instance-attribute

event_logs = Field(alias='eventLogs')

transitions class-attribute instance-attribute

transitions = Field(alias='transitions')

kpi_views class-attribute instance-attribute

kpi_views = Field(alias='kpiViews')

ParameterMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

default_value class-attribute instance-attribute

default_value = Field(alias='defaultValue')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

PerformanceBucket

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

text_snippet class-attribute instance-attribute

text_snippet = Field(alias='textSnippet')

text_snippet_active class-attribute instance-attribute

text_snippet_active = Field(alias='textSnippetActive')

upper_value class-attribute instance-attribute

upper_value = Field(alias='upperValue')

lower_value class-attribute instance-attribute

lower_value = Field(alias='lowerValue')

PqlBaseMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

RecordPriorityMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

kpi class-attribute instance-attribute

kpi = Field(alias='kpi')

SingleEventLogMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

pql class-attribute instance-attribute

pql = Field(alias='pql')

filter_ids class-attribute instance-attribute

filter_ids = Field(alias='filterIds')

record_id class-attribute instance-attribute

record_id = Field(alias='recordId')

default_event_log class-attribute instance-attribute

default_event_log = Field(alias='defaultEventLog')

TargetMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

value class-attribute instance-attribute

value = Field(alias='value')

date_from class-attribute instance-attribute

date_from = Field(alias='dateFrom')

date_until class-attribute instance-attribute

date_until = Field(alias='dateUntil')

filters class-attribute instance-attribute

filters = Field(alias='filters')

VariableMetadata

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

display_name class-attribute instance-attribute

display_name = Field(alias='displayName')

short_display_name class-attribute instance-attribute

short_display_name = Field(alias='shortDisplayName')

description class-attribute instance-attribute

description = Field(alias='description')

scope class-attribute instance-attribute

scope = Field(alias='scope')

internal_note class-attribute instance-attribute

internal_note = Field(alias='internalNote')

custom_attributes class-attribute instance-attribute

custom_attributes = Field(alias='customAttributes')

auto_generated class-attribute instance-attribute

auto_generated = Field(alias='autoGenerated')

value class-attribute instance-attribute

value = Field(alias='value')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

ComputeCallerInfo

Bases: PyCelonisBaseModel

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

object_type class-attribute instance-attribute

object_type = Field(alias='objectType')

DataCommand

Bases: PyCelonisBaseModel

cube_id class-attribute instance-attribute

cube_id = Field(alias='cubeId')

commands class-attribute instance-attribute

commands = Field(alias='commands')

DataCommandBatchRequest

Bases: PyCelonisBaseModel

variables class-attribute instance-attribute

variables = Field(alias='variables')

requests class-attribute instance-attribute

requests = Field(alias='requests')

DataCommandBatchTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

request class-attribute instance-attribute

request = Field(alias='request')

DataQuery

Bases: PyCelonisBaseModel

computation_id class-attribute instance-attribute

computation_id = Field(alias='computationId')

queries class-attribute instance-attribute

queries = Field(alias='queries')

is_transient class-attribute instance-attribute

is_transient = Field(alias='isTransient')

LayerComputeTransport

Bases: PyCelonisBaseModel

caller_info class-attribute instance-attribute

caller_info = Field(alias='callerInfo')

layer class-attribute instance-attribute

layer = Field(alias='layer')

request class-attribute instance-attribute

request = Field(alias='request')

draft class-attribute instance-attribute

draft = Field(alias='draft')

QueryRequest

Bases: PyCelonisBaseModel

batch_request class-attribute instance-attribute

batch_request = Field(alias='batchRequest')

filters class-attribute instance-attribute

filters = Field(alias='filters')

Variable

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

type_ class-attribute instance-attribute

type_ = Field(alias='type')

value class-attribute instance-attribute

value = Field(alias='value')

DataPermissionRule

Bases: PyCelonisBaseModel

values class-attribute instance-attribute

values = Field(alias='values')

column_id class-attribute instance-attribute

column_id = Field(alias='columnId')

table_id class-attribute instance-attribute

table_id = Field(alias='tableId')

Kpi

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

template class-attribute instance-attribute

template = Field(alias='template')

parameter_count class-attribute instance-attribute

parameter_count = Field(alias='parameterCount')

error class-attribute instance-attribute

error = Field(alias='error')

formula class-attribute instance-attribute

formula = Field(alias='formula')

KpiInformation

Bases: PyCelonisBaseModel

kpis class-attribute instance-attribute

kpis = Field(alias='kpis')

PostBatchQueryTransport

Bases: PyCelonisBaseModel

analysis_commands class-attribute instance-attribute

analysis_commands = Field(alias='analysisCommands')

query_environment class-attribute instance-attribute

query_environment = Field(alias='queryEnvironment')

QueryEnvironment

Bases: PyCelonisBaseModel

accelerator_session_id class-attribute instance-attribute

accelerator_session_id = Field(alias="acceleratorSessionId")

process_id class-attribute instance-attribute

process_id = Field(alias='processId')

user_id class-attribute instance-attribute

user_id = Field(alias='userId')

user_name class-attribute instance-attribute

user_name = Field(alias='userName')

load_script class-attribute instance-attribute

load_script = Field(alias='loadScript')

kpi_infos class-attribute instance-attribute

kpi_infos = Field(alias='kpiInfos')

data_permission_rules class-attribute instance-attribute

data_permission_rules = Field(alias='dataPermissionRules')

data_permission_strategy class-attribute instance-attribute

data_permission_strategy = Field(
    alias="dataPermissionStrategy"
)

SemanticLayerService

post_api_semantic_models staticmethod

post_api_semantic_models(client, request_body)

post_api_layer_id_name_final staticmethod

post_api_layer_id_name_final(client, id_name, request_body)

post_api_knowledge_model_resolve_query staticmethod

post_api_knowledge_model_resolve_query(
    client, request_body
)

get_api_knowledge_model_layer_asset_id_kpis staticmethod

get_api_knowledge_model_layer_asset_id_kpis(
    client, layer_asset_id
)

post_api_knowledge_model_layer_asset_id_kpis staticmethod

post_api_knowledge_model_layer_asset_id_kpis(
    client, layer_asset_id, request_body
)

get_api_knowledge_model_layer_asset_id_kpis_kpi_id staticmethod

get_api_knowledge_model_layer_asset_id_kpis_kpi_id(
    client, layer_asset_id, kpi_id
)

put_api_knowledge_model_layer_asset_id_kpis_kpi_id staticmethod

put_api_knowledge_model_layer_asset_id_kpis_kpi_id(
    client, layer_asset_id, kpi_id, request_body
)

delete_api_knowledge_model_layer_asset_id_kpis_kpi_id staticmethod

delete_api_knowledge_model_layer_asset_id_kpis_kpi_id(
    client, layer_asset_id, kpi_id
)

get_api_knowledge_model_layer_asset_id_filters staticmethod

get_api_knowledge_model_layer_asset_id_filters(
    client, layer_asset_id
)

post_api_knowledge_model_layer_asset_id_filters staticmethod

post_api_knowledge_model_layer_asset_id_filters(
    client, layer_asset_id, request_body
)

get_api_knowledge_model_layer_asset_id_filters_filter_id staticmethod

get_api_knowledge_model_layer_asset_id_filters_filter_id(
    client, layer_asset_id, filter_id
)

put_api_knowledge_model_layer_asset_id_filters_filter_id staticmethod

put_api_knowledge_model_layer_asset_id_filters_filter_id(
    client, layer_asset_id, filter_id, request_body
)

delete_api_knowledge_model_layer_asset_id_filters_filter_id staticmethod

delete_api_knowledge_model_layer_asset_id_filters_filter_id(
    client, layer_asset_id, filter_id
)

get_api_knowledge_model_layer_asset_id_variables staticmethod

get_api_knowledge_model_layer_asset_id_variables(
    client, layer_asset_id
)

post_api_knowledge_model_layer_asset_id_variables staticmethod

post_api_knowledge_model_layer_asset_id_variables(
    client, layer_asset_id, request_body
)

get_api_knowledge_model_layer_asset_id_variables_variable_id staticmethod

get_api_knowledge_model_layer_asset_id_variables_variable_id(
    client, layer_asset_id, variable_id
)

put_api_knowledge_model_layer_asset_id_variables_variable_id staticmethod

put_api_knowledge_model_layer_asset_id_variables_variable_id(
    client, layer_asset_id, variable_id, request_body
)

delete_api_knowledge_model_layer_asset_id_variables_variable_id staticmethod

delete_api_knowledge_model_layer_asset_id_variables_variable_id(
    client, layer_asset_id, variable_id
)