service

JsonNode module-attribute

JsonNode = Any

CascadeType

Bases: Enum

DELETE class-attribute

DELETE = 'DELETE'

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'

KpiDirection

Bases: Enum

INCREASE class-attribute

INCREASE = 'INCREASE'

DECREASE class-attribute

DECREASE = 'DECREASE'

NEUTRAL class-attribute

NEUTRAL = 'NEUTRAL'

NONE class-attribute

NONE = 'NONE'

LayerKind

Bases: Enum

BASE class-attribute

BASE = 'BASE'

EXTENSION class-attribute

EXTENSION = 'EXTENSION'

MetadataType

Bases: Enum

KPI class-attribute

KPI = 'KPI'

RECORD class-attribute

RECORD = 'RECORD'

VARIABLE class-attribute

VARIABLE = 'VARIABLE'

ACTIVITY class-attribute

ACTIVITY = 'ACTIVITY'

FILTER class-attribute

FILTER = 'FILTER'

ACTION class-attribute

ACTION = 'ACTION'

ANOMALY class-attribute

ANOMALY = 'ANOMALY'

ATTRIBUTE class-attribute

ATTRIBUTE = 'ATTRIBUTE'

NEW_ATTRIBUTE class-attribute

NEW_ATTRIBUTE = 'NEW_ATTRIBUTE'

AUGMENTED_ATTRIBUTE class-attribute

AUGMENTED_ATTRIBUTE = 'AUGMENTED_ATTRIBUTE'

PRIORITY class-attribute

PRIORITY = 'PRIORITY'

FLAG class-attribute

FLAG = 'FLAG'

EVENT_LOG class-attribute

EVENT_LOG = 'EVENT_LOG'

DATA_TRIGGER class-attribute

DATA_TRIGGER = 'DATA_TRIGGER'

ParameterType

Bases: Enum

VARIABLE class-attribute

VARIABLE = 'VARIABLE'

TABLE class-attribute

TABLE = 'TABLE'

INTEGER class-attribute

INTEGER = 'INTEGER'

TEXT class-attribute

TEXT = 'TEXT'

PQL class-attribute

PQL = 'PQL'

ScopeType

Bases: Enum

DISABLED class-attribute

DISABLED = 'DISABLED'

TransitionType

Bases: Enum

NON_INTERLEAVED class-attribute

NON_INTERLEAVED = 'NON_INTERLEAVED'

INTERLEAVED class-attribute

INTERLEAVED = 'INTERLEAVED'

ComputeCallerType

Bases: Enum

PROCESS_WORKSPACE class-attribute

PROCESS_WORKSPACE = 'PROCESS_WORKSPACE'

KNOWLEDGE_MODEL class-attribute

KNOWLEDGE_MODEL = 'KNOWLEDGE_MODEL'

VIEW class-attribute

VIEW = 'VIEW'

DATA_MODEL class-attribute

DATA_MODEL = 'DATA_MODEL'

DataPermissionStrategy

Bases: Enum

AND class-attribute

AND = 'AND'

OR class-attribute

OR = 'OR'

ExceptionReference

Bases: PyCelonisBaseModel

reference class-attribute

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

message class-attribute

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

short_message class-attribute

short_message: Optional[str] = Field(alias='shortMessage')

FrontendHandledBackendError

Bases: PyCelonisBaseModel

frontend_error_key class-attribute

frontend_error_key: Optional[str] = Field(
    alias="frontendErrorKey"
)

error_information class-attribute

error_information: Optional[Any] = Field(
    alias="errorInformation"
)

FinalModelOptions

Bases: PyCelonisBaseModel

with_variable_replacement class-attribute

with_variable_replacement: Optional[bool] = Field(
    alias="withVariableReplacement"
)

with_autogenerated_data_model_data class-attribute

with_autogenerated_data_model_data: Optional[bool] = Field(
    alias="withAutogeneratedDataModelData"
)

with_default_values class-attribute

with_default_values: Optional[bool] = Field(
    alias="withDefaultValues"
)

validate_pql class-attribute

validate_pql: Optional[bool] = Field(alias='validatePql')

with_unknown_variables_validation class-attribute

with_unknown_variables_validation: Optional[bool] = Field(
    alias="withUnknownVariablesValidation"
)

with_resolved_scopes class-attribute

with_resolved_scopes: Optional[bool] = Field(
    alias="withResolvedScopes"
)

YamlMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

key class-attribute

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

parent_node_id class-attribute

parent_node_id: Optional[str] = Field(alias='parentNodeId')

final_model_options class-attribute

final_model_options: Optional[FinalModelOptions] = Field(
    alias="finalModelOptions"
)

content class-attribute

content: Optional[str] = Field(alias='content')

visual_editor_validation class-attribute

visual_editor_validation: Optional[bool] = Field(
    alias="visualEditorValidation"
)

AssetMetadataTransport

Bases: PyCelonisBaseModel

used_variables class-attribute

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

related_assets class-attribute

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

asset_usages class-attribute

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

metadata class-attribute

metadata: Optional[JsonNode] = Field(alias='metadata')

hidden class-attribute

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

AssetUsage

Bases: PyCelonisBaseModel

object_id class-attribute

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

target_objects class-attribute

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

ContentNodeBaseTransport

Bases: PyCelonisBaseModel

reference class-attribute

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

version class-attribute

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

external class-attribute

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

ContentNodeTransport

Bases: PyCelonisBaseModel

permissions class-attribute

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

tenant_id class-attribute

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

id class-attribute

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

key class-attribute

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

name class-attribute

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

root_node_key class-attribute

root_node_key: Optional[str] = Field(alias='rootNodeKey')

base class-attribute

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

asset_type class-attribute

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

node_type class-attribute

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

parent_node_key class-attribute

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

parent_node_id class-attribute

parent_node_id: Optional[str] = Field(alias='parentNodeId')

invalid_content class-attribute

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

serialized_content class-attribute

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

serialization_type class-attribute

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

draft_id class-attribute

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

working_draft_id class-attribute

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

activated_draft_id class-attribute

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

show_in_viewer_mode class-attribute

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

public_available class-attribute

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

embeddable class-attribute

embeddable: Optional[bool] = Field(alias='embeddable')

root_node_id class-attribute

root_node_id: Optional[str] = Field(alias='rootNodeId')

order class-attribute

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

source class-attribute

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

asset_metadata_transport class-attribute

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

space_id class-attribute

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

change_date class-attribute

change_date: Optional[datetime] = Field(alias='changeDate')

created_by_id class-attribute

created_by_id: Optional[str] = Field(alias='createdById')

creation_date class-attribute

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

created_by_name class-attribute

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

updated_by class-attribute

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

asset class-attribute

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

root class-attribute

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

object_id class-attribute

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

root_with_key class-attribute

root_with_key: Optional[str] = Field(alias='rootWithKey')

identifier class-attribute

identifier: Optional[str] = Field(alias='identifier')

RelatedAsset

Bases: PyCelonisBaseModel

object_id class-attribute

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

type_ class-attribute

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

relation_type class-attribute

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

cascade_type class-attribute

cascade_type: Optional[CascadeType] = Field(
    alias="cascadeType"
)

SourceUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

TargetUsageMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

type_ class-attribute

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

source_objects class-attribute

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

VariableDefinition

Bases: PyCelonisBaseModel

key class-attribute

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

type_ class-attribute

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

description class-attribute

description: Optional[str] = Field(alias='description')

source class-attribute

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

runtime class-attribute

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

metadata class-attribute

metadata: Optional[JsonNode] = Field(alias='metadata')

ActionInput

Bases: PyCelonisBaseModel

name class-attribute

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

attribute class-attribute

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

ActionMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

skill_id class-attribute

skill_id: Optional[str] = Field(alias='skillId')

skill_key class-attribute

skill_key: Optional[str] = Field(alias='skillKey')

records class-attribute

records: Optional[List[Optional[str]]] = Field(
    alias="records"
)

filters class-attribute

filters: Optional[List[Optional[str]]] = Field(
    alias="filters"
)

inputs class-attribute

inputs: Optional[List[Optional[ActionInput]]] = Field(
    alias="inputs"
)

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

ActivityMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

value class-attribute

value: Optional[str] = Field(alias='value')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

AlertMetric

Bases: PyCelonisBaseModel

id class-attribute

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

pql class-attribute

pql: Optional[str] = Field(alias='pql')

message class-attribute

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

AnomalyKpiMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

kpi_id class-attribute

kpi_id: Optional[str] = Field(alias='kpiId')

impact_calculation class-attribute

impact_calculation: Optional[str] = Field(
    alias="impactCalculation"
)

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

AnomalyMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

flag class-attribute

flag: Optional[str] = Field(alias='flag')

kpi_ids class-attribute

kpi_ids: Optional[List[Optional[str]]] = Field(
    alias="kpiIds"
)

kpis class-attribute

kpis: Optional[List[Optional[AnomalyKpiMetadata]]] = Field(
    alias="kpis"
)

mom_change class-attribute

mom_change: Optional[str] = Field(alias='momChange')

knowledge_object_id class-attribute

knowledge_object_id: Optional[str] = Field(
    alias="knowledgeObjectId"
)

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

AttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

column_type class-attribute

column_type: Optional[str] = Field(alias='columnType')

unit class-attribute

unit: Optional[str] = Field(alias='unit')

format class-attribute

format: Optional[str] = Field(alias='format')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

AugmentedAttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

possible_values class-attribute

possible_values: Optional[List[Optional[str]]] = Field(
    alias="possibleValues"
)

default_value class-attribute

default_value: Optional[str] = Field(alias='defaultValue')

column_type class-attribute

column_type: Optional[str] = Field(alias='columnType')

pql class-attribute

pql: Optional[str] = Field(alias='pql')

unit class-attribute

unit: Optional[str] = Field(alias='unit')

format class-attribute

format: Optional[str] = Field(alias='format')

housekeeping class-attribute

housekeeping: Optional[bool] = Field(alias='housekeeping')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

BaseMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

BusinessRecordMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

augmented class-attribute

augmented: Optional[bool] = Field(alias='augmented')

identifier class-attribute

identifier: Optional[PqlBaseMetadata] = Field(
    alias="identifier"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

attributes class-attribute

attributes: Optional[
    List[Optional[AttributeMetadata]]
] = Field(alias="attributes")

new_attributes class-attribute

new_attributes: Optional[
    List[Optional[NewAttributeMetadata]]
] = Field(alias="newAttributes")

augmented_attributes class-attribute

augmented_attributes: Optional[
    List[Optional[AugmentedAttributeMetadata]]
] = Field(alias="augmentedAttributes")

flags class-attribute

flags: Optional[List[Optional[PqlBaseMetadata]]] = Field(
    alias="flags"
)

priorities class-attribute

priorities: Optional[
    List[Optional[RecordPriorityMetadata]]
] = Field(alias="priorities")

data_triggers class-attribute

data_triggers: Optional[
    List[Optional[DataTriggerMetadata]]
] = Field(alias="dataTriggers")

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

DataTriggerMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

EventLogKpi

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

event_log_id class-attribute

event_log_id: Optional[str] = Field(alias='eventLogId')

node_kpi_ids class-attribute

node_kpi_ids: Optional[List[Optional[str]]] = Field(
    alias="nodeKpiIds"
)

edge_kpi_ids class-attribute

edge_kpi_ids: Optional[List[Optional[str]]] = Field(
    alias="edgeKpiIds"
)

node_kpis class-attribute

node_kpis: Optional[List[Optional[KpiWithAlert]]] = Field(
    alias="nodeKpis"
)

edge_kpis class-attribute

edge_kpis: Optional[List[Optional[KpiWithAlert]]] = Field(
    alias="edgeKpis"
)

EventLogKpiView

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

icon class-attribute

icon: Optional[str] = Field(alias='icon')

event_log_kpis class-attribute

event_log_kpis: Optional[
    List[Optional[EventLogKpi]]
] = Field(alias="eventLogKpis")

transition_kpis class-attribute

transition_kpis: Optional[
    List[Optional[EventLogTransitionKpi]]
] = Field(alias="transitionKpis")

EventLogMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

EventLogTransition

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

first_event_log_id class-attribute

first_event_log_id: Optional[str] = Field(
    alias="firstEventLogId"
)

second_event_log_id class-attribute

second_event_log_id: Optional[str] = Field(
    alias="secondEventLogId"
)

type_ class-attribute

type_: Optional[TransitionType] = Field(alias='type')

EventLogTransitionKpi

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

transition_id class-attribute

transition_id: Optional[str] = Field(alias='transitionId')

kpi_id class-attribute

kpi_id: Optional[str] = Field(alias='kpiId')

FilterMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

global_ class-attribute

global_: Optional[bool] = Field(alias='global')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

FinalLayerTransport

Bases: PyCelonisBaseModel

id class-attribute

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

layer class-attribute

layer: Optional[LayerTransport] = Field(alias='layer')

yaml_object class-attribute

yaml_object: Optional[str] = Field(alias='yamlObject')

KpiBenchmarking

Bases: PyCelonisBaseModel

value class-attribute

value: Optional[str] = Field(alias='value')

action class-attribute

action: Optional[KpiBenchmarkingAction] = Field(
    alias="action"
)

leading_bucket class-attribute

leading_bucket: Optional[PerformanceBucket] = Field(
    alias="leadingBucket"
)

exceeding_bucket class-attribute

exceeding_bucket: Optional[PerformanceBucket] = Field(
    alias="exceedingBucket"
)

achieving_bucket class-attribute

achieving_bucket: Optional[PerformanceBucket] = Field(
    alias="achievingBucket"
)

lagging_bucket class-attribute

lagging_bucket: Optional[PerformanceBucket] = Field(
    alias="laggingBucket"
)

KpiBenchmarkingAction

Bases: PyCelonisBaseModel

name class-attribute

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

description class-attribute

description: Optional[str] = Field(alias='description')

link class-attribute

link: Optional[str] = Field(alias='link')

KpiMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

unit class-attribute

unit: Optional[str] = Field(alias='unit')

format class-attribute

format: Optional[str] = Field(alias='format')

breakdowns class-attribute

breakdowns: Optional[List[Optional[BaseMetadata]]] = Field(
    alias="breakdowns"
)

aggregations class-attribute

aggregations: Optional[List[Optional[str]]] = Field(
    alias="aggregations"
)

parameters class-attribute

parameters: Optional[
    List[Optional[ParameterMetadata]]
] = Field(alias="parameters")

targets class-attribute

targets: Optional[List[Optional[TargetMetadata]]] = Field(
    alias="targets"
)

desired_direction class-attribute

desired_direction: Optional[KpiDirection] = Field(
    alias="desiredDirection"
)

priority class-attribute

priority: Optional[bool] = Field(alias='priority')

benchmarking class-attribute

benchmarking: Optional[KpiBenchmarking] = Field(
    alias="benchmarking"
)

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

benchmarkable class-attribute

benchmarkable: Optional[bool] = Field(alias="benchmarkable")

KpiWithAlert

Bases: PyCelonisBaseModel

id class-attribute

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

kpi_id class-attribute

kpi_id: Optional[str] = Field(alias='kpiId')

icon class-attribute

icon: Optional[str] = Field(alias='icon')

alert_metrics class-attribute

alert_metrics: Optional[
    List[Optional[AlertMetric]]
] = Field(alias="alertMetrics")

LayerBase

Bases: PyCelonisBaseModel

key class-attribute

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

version class-attribute

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

app_store_based class-attribute

app_store_based: Optional[bool] = Field(
    alias="appStoreBased"
)

LayerMetadata

Bases: PyCelonisBaseModel

key class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

version class-attribute

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

LayerTransport

Bases: PyCelonisBaseModel

kind class-attribute

kind: Optional[LayerKind] = Field(alias='kind')

metadata class-attribute

metadata: Optional[LayerMetadata] = Field(alias='metadata')

base class-attribute

base: Optional[LayerBase] = Field(alias='base')

data_model_id class-attribute

data_model_id: Optional[str] = Field(alias='dataModelId')

records class-attribute

records: Optional[
    List[Optional[BusinessRecordMetadata]]
] = Field(alias="records")

kpis class-attribute

kpis: Optional[List[Optional[KpiMetadata]]] = Field(
    alias="kpis"
)

filters class-attribute

filters: Optional[List[Optional[FilterMetadata]]] = Field(
    alias="filters"
)

variables class-attribute

variables: Optional[
    List[Optional[VariableMetadata]]
] = Field(alias="variables")

activities class-attribute

activities: Optional[
    List[Optional[ActivityMetadata]]
] = Field(alias="activities")

event_logs_metadata class-attribute

event_logs_metadata: Optional[NewEventLogMetadata] = Field(
    alias="eventLogsMetadata"
)

anomalies class-attribute

anomalies: Optional[
    List[Optional[AnomalyMetadata]]
] = Field(alias="anomalies")

event_logs class-attribute

event_logs: Optional[
    List[Optional[EventLogMetadata]]
] = Field(alias="eventLogs")

custom_objects class-attribute

custom_objects: Optional[
    List[Optional[BaseMetadata]]
] = Field(alias="customObjects")

id class-attribute

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

tenant_id class-attribute

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

actions class-attribute

actions: Optional[List[Optional[ActionMetadata]]] = Field(
    alias="actions"
)

node_entity_id class-attribute

node_entity_id: Optional[str] = Field(alias='nodeEntityId')

NewAttributeMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

possible_values class-attribute

possible_values: Optional[List[Optional[str]]] = Field(
    alias="possibleValues"
)

default_value class-attribute

default_value: Optional[str] = Field(alias='defaultValue')

column_type class-attribute

column_type: Optional[str] = Field(alias='columnType')

unit class-attribute

unit: Optional[str] = Field(alias='unit')

format class-attribute

format: Optional[str] = Field(alias='format')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

NewEventLogMetadata

Bases: PyCelonisBaseModel

event_logs class-attribute

event_logs: Optional[
    List[Optional[SingleEventLogMetadata]]
] = Field(alias="eventLogs")

transitions class-attribute

transitions: Optional[
    List[Optional[EventLogTransition]]
] = Field(alias="transitions")

kpi_views class-attribute

kpi_views: Optional[
    List[Optional[EventLogKpiView]]
] = Field(alias="kpiViews")

ParameterMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

default_value class-attribute

default_value: Optional[str] = Field(alias='defaultValue')

type_ class-attribute

type_: Optional[ParameterType] = Field(alias='type')

PerformanceBucket

Bases: PyCelonisBaseModel

name class-attribute

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

text_snippet class-attribute

text_snippet: Optional[str] = Field(alias='textSnippet')

text_snippet_active class-attribute

text_snippet_active: Optional[str] = Field(
    alias="textSnippetActive"
)

upper_value class-attribute

upper_value: Optional[str] = Field(alias='upperValue')

lower_value class-attribute

lower_value: Optional[str] = Field(alias='lowerValue')

PqlBaseMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

RecordPriorityMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

kpi class-attribute

kpi: Optional[str] = Field(alias='kpi')

SingleEventLogMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

pql class-attribute

pql: Optional[str] = Field(alias='pql')

filter_ids class-attribute

filter_ids: Optional[List[Optional[str]]] = Field(
    alias="filterIds"
)

record_id class-attribute

record_id: Optional[str] = Field(alias='recordId')

default_event_log class-attribute

default_event_log: Optional[bool] = Field(
    alias="defaultEventLog"
)

TargetMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

value class-attribute

value: Optional[str] = Field(alias='value')

date_from class-attribute

date_from: Optional[str] = Field(alias='dateFrom')

date_until class-attribute

date_until: Optional[str] = Field(alias='dateUntil')

filters class-attribute

filters: Optional[List[Optional[str]]] = Field(
    alias="filters"
)

VariableMetadata

Bases: PyCelonisBaseModel

id class-attribute

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

display_name class-attribute

display_name: Optional[str] = Field(alias='displayName')

short_display_name class-attribute

short_display_name: Optional[str] = Field(
    alias="shortDisplayName"
)

description class-attribute

description: Optional[str] = Field(alias='description')

scope class-attribute

scope: Optional[ScopeType] = Field(alias='scope')

internal_note class-attribute

internal_note: Optional[str] = Field(alias='internalNote')

custom_attributes class-attribute

custom_attributes: Optional[JsonNode] = Field(
    alias="customAttributes"
)

auto_generated class-attribute

auto_generated: Optional[bool] = Field(
    alias="autoGenerated"
)

value class-attribute

value: Optional[str] = Field(alias='value')

type_ class-attribute

type_: Optional[MetadataType] = Field(alias='type')

ComputeCallerInfo

Bases: PyCelonisBaseModel

object_id class-attribute

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

object_type class-attribute

object_type: Optional[ComputeCallerType] = Field(
    alias="objectType"
)

DataCommand

Bases: PyCelonisBaseModel

cube_id class-attribute

cube_id: Optional[str] = Field(alias='cubeId')

commands class-attribute

commands: Optional[List[Optional[DataQuery]]] = Field(
    alias="commands"
)

DataCommandBatchRequest

Bases: PyCelonisBaseModel

variables class-attribute

variables: Optional[List[Optional[Variable]]] = Field(
    alias="variables"
)

requests class-attribute

requests: Optional[
    List[Optional[DataCommandBatchTransport]]
] = Field(alias="requests")

DataCommandBatchTransport

Bases: PyCelonisBaseModel

id class-attribute

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

request class-attribute

request: Optional[DataCommand] = Field(alias='request')

DataQuery

Bases: PyCelonisBaseModel

computation_id class-attribute

computation_id: Optional[int] = Field(alias="computationId")

queries class-attribute

queries: Optional[List[Optional[str]]] = Field(
    alias="queries"
)

is_transient class-attribute

is_transient: Optional[bool] = Field(alias='isTransient')

LayerComputeTransport

Bases: PyCelonisBaseModel

caller_info class-attribute

caller_info: Optional[ComputeCallerInfo] = Field(
    alias="callerInfo"
)

layer class-attribute

layer: Optional[LayerTransport] = Field(alias='layer')

request class-attribute

request: Optional[QueryRequest] = Field(alias='request')

draft class-attribute

draft: Optional[bool] = Field(alias='draft')

QueryRequest

Bases: PyCelonisBaseModel

batch_request class-attribute

batch_request: Optional[DataCommandBatchRequest] = Field(
    alias="batchRequest"
)

filters class-attribute

filters: Optional[List[Optional[str]]] = Field(
    alias="filters"
)

Variable

Bases: PyCelonisBaseModel

name class-attribute

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

type_ class-attribute

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

value class-attribute

value: Optional[str] = Field(alias='value')

DataPermissionRule

Bases: PyCelonisBaseModel

values class-attribute

values: Optional[List[Optional[str]]] = Field(
    alias="values"
)

column_id class-attribute

column_id: Optional[str] = Field(alias='columnId')

table_id class-attribute

table_id: Optional[str] = Field(alias='tableId')

Kpi

Bases: PyCelonisBaseModel

name class-attribute

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

template class-attribute

template: Optional[str] = Field(alias='template')

parameter_count class-attribute

parameter_count: Optional[int] = Field(
    alias="parameterCount"
)

error class-attribute

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

formula class-attribute

formula: Optional[str] = Field(alias='formula')

KpiInformation

Bases: PyCelonisBaseModel

kpis class-attribute

kpis: Optional[Dict[str, Optional[Kpi]]] = Field(
    alias="kpis"
)

PostBatchQueryTransport

Bases: PyCelonisBaseModel

analysis_commands class-attribute

analysis_commands: Optional[
    List[Optional[DataCommandBatchTransport]]
] = Field(alias="analysisCommands")

query_environment class-attribute

query_environment: Optional[QueryEnvironment] = Field(
    alias="queryEnvironment"
)

QueryEnvironment

Bases: PyCelonisBaseModel

accelerator_session_id class-attribute

accelerator_session_id: Optional[str] = Field(
    alias="acceleratorSessionId"
)

process_id class-attribute

process_id: Optional[str] = Field(alias='processId')

user_id class-attribute

user_id: Optional[str] = Field(alias='userId')

user_name class-attribute

user_name: Optional[str] = Field(alias='userName')

load_script class-attribute

load_script: Optional[str] = Field(alias='loadScript')

kpi_infos class-attribute

kpi_infos: Optional[KpiInformation] = Field(
    alias="kpiInfos"
)

data_permission_rules class-attribute

data_permission_rules: Optional[
    List[Optional[DataPermissionRule]]
] = Field(alias="dataPermissionRules")

data_permission_strategy class-attribute

data_permission_strategy: Optional[
    DataPermissionStrategy
] = 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
)