service

KpiSource

Bases: PyCelonisBaseEnum

LOCAL class-attribute instance-attribute

LOCAL = 'LOCAL'

KNOWLEDGE_MODEL class-attribute instance-attribute

KNOWLEDGE_MODEL = 'KNOWLEDGE_MODEL'

DataPermissionStrategy

Bases: PyCelonisBaseEnum

AND class-attribute instance-attribute

AND = 'AND'

OR class-attribute instance-attribute

OR = 'OR'

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

AnalysisPackageConfig

Bases: PyCelonisBaseModel

root_node_key class-attribute instance-attribute

root_node_key = Field(alias='rootNodeKey')

id class-attribute instance-attribute

id = Field(alias='id')

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

name class-attribute instance-attribute

name = Field(alias='name')

data_model_id class-attribute instance-attribute

data_model_id = Field(alias='dataModelId')

key class-attribute instance-attribute

key = Field(alias='key')

root_node_id class-attribute instance-attribute

root_node_id = Field(alias='rootNodeId')

knowledge_model_key class-attribute instance-attribute

knowledge_model_key = Field(alias='knowledgeModelKey')

change_default_event_log class-attribute instance-attribute

change_default_event_log = Field(
    alias="changeDefaultEventLog"
)

event_log class-attribute instance-attribute

event_log = Field(alias='eventLog')

custom_dimension class-attribute instance-attribute

custom_dimension = Field(alias='customDimension')

AnalysisPackageTransport

Bases: PyCelonisBaseModel

analysis class-attribute instance-attribute

analysis = Field(alias='analysis')

kpis class-attribute instance-attribute

kpis = Field(alias='kpis')

draft class-attribute instance-attribute

draft = Field(alias='draft')

data_model_id class-attribute instance-attribute

data_model_id = Field(alias='dataModelId')

knowledge_model_key class-attribute instance-attribute

knowledge_model_key = Field(alias='knowledgeModelKey')

next_draft_creation_date_time class-attribute instance-attribute

next_draft_creation_date_time = Field(
    alias="nextDraftCreationDateTime"
)

change_default_event_log class-attribute instance-attribute

change_default_event_log = Field(
    alias="changeDefaultEventLog"
)

event_log class-attribute instance-attribute

event_log = Field(alias='eventLog')

custom_dimension class-attribute instance-attribute

custom_dimension = Field(alias='customDimension')

AnalysisTransport

Bases: PyCelonisBaseModel

permissions class-attribute instance-attribute

permissions = Field(alias='permissions')

id class-attribute instance-attribute

id = Field(alias='id')

tenant_id class-attribute instance-attribute

tenant_id = Field(alias='tenantId')

name class-attribute instance-attribute

name = Field(alias='name')

key class-attribute instance-attribute

key = Field(alias='key')

description class-attribute instance-attribute

description = Field(alias='description')

deleted class-attribute instance-attribute

deleted = Field(alias='deleted')

transport_id class-attribute instance-attribute

transport_id = Field(alias='transportId')

last_published_draft_id class-attribute instance-attribute

last_published_draft_id = Field(
    alias="lastPublishedDraftId"
)

auto_save_id class-attribute instance-attribute

auto_save_id = Field(alias='autoSaveId')

process_id class-attribute instance-attribute

process_id = Field(alias='processId')

create_date class-attribute instance-attribute

create_date = Field(alias='createDate')

favourite class-attribute instance-attribute

favourite = Field(alias='favourite')

content_id class-attribute instance-attribute

content_id = Field(alias='contentId')

content_version class-attribute instance-attribute

content_version = Field(alias='contentVersion')

tags class-attribute instance-attribute

tags = Field(alias='tags')

application_id class-attribute instance-attribute

application_id = Field(alias='applicationId')

global_app class-attribute instance-attribute

global_app = Field(alias='globalApp')

public_link class-attribute instance-attribute

public_link = Field(alias='publicLink')

last_published_date class-attribute instance-attribute

last_published_date = Field(alias='lastPublishedDate')

last_published_user class-attribute instance-attribute

last_published_user = Field(alias='lastPublishedUser')

parent_object_id class-attribute instance-attribute

parent_object_id = Field(alias='parentObjectId')

published_draft_id class-attribute instance-attribute

published_draft_id = Field(alias='publishedDraftId')

folder_id class-attribute instance-attribute

folder_id = Field(alias='folderId')

object_id class-attribute instance-attribute

object_id = Field(alias='objectId')

application class-attribute instance-attribute

application = Field(alias='application')

DraftTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

title class-attribute instance-attribute

title = Field(alias='title')

document class-attribute instance-attribute

document = Field(alias='document')

last_change_date class-attribute instance-attribute

last_change_date = Field(alias='lastChangeDate')

last_change_user_id class-attribute instance-attribute

last_change_user_id = Field(alias='lastChangeUserId')

last_change_user_name class-attribute instance-attribute

last_change_user_name = Field(alias='lastChangeUserName')

locked_until_date class-attribute instance-attribute

locked_until_date = Field(alias='lockedUntilDate')

source_id class-attribute instance-attribute

source_id = Field(alias='sourceId')

KpiTransport

Bases: PyCelonisBaseModel

id class-attribute instance-attribute

id = Field(alias='id')

name class-attribute instance-attribute

name = Field(alias='name')

description class-attribute instance-attribute

description = Field(alias='description')

template class-attribute instance-attribute

template = Field(alias='template')

parameters class-attribute instance-attribute

parameters = Field(alias='parameters')

parameter_count class-attribute instance-attribute

parameter_count = Field(alias='parameterCount')

source class-attribute instance-attribute

source = Field(alias='source')

unit class-attribute instance-attribute

unit = Field(alias='unit')

value_format class-attribute instance-attribute

value_format = Field(alias='valueFormat')

Tag

Bases: PyCelonisBaseModel

name class-attribute instance-attribute

name = Field(alias='name')

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

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

ProcessAnalyticsService

post_analysis_v2_api_analysis staticmethod

post_analysis_v2_api_analysis(client, request_body)

post_analysis_v2_api_analysis_analysis_id_kpi staticmethod

post_analysis_v2_api_analysis_analysis_id_kpi(
    client, analysis_id, request_body
)

post_analysis_v2_api_analysis_analysis_id_data_command staticmethod

post_analysis_v2_api_analysis_analysis_id_data_command(
    client, analysis_id, request_body
)