service

KpiSource

Bases: Enum

LOCAL class-attribute

LOCAL = 'LOCAL'

KNOWLEDGE_MODEL class-attribute

KNOWLEDGE_MODEL = 'KNOWLEDGE_MODEL'

DataPermissionStrategy

Bases: Enum

AND class-attribute

AND = 'AND'

OR class-attribute

OR = 'OR'

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

AnalysisPackageConfig

Bases: PyCelonisBaseModel

root_node_key class-attribute

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

id class-attribute

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

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

name class-attribute

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

data_model_id class-attribute

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

key class-attribute

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

root_node_id class-attribute

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

knowledge_model_key class-attribute

knowledge_model_key: Optional[str] = Field(
    alias="knowledgeModelKey"
)

change_default_event_log class-attribute

change_default_event_log: Optional[bool] = Field(
    alias="changeDefaultEventLog"
)

event_log class-attribute

event_log: Optional[str] = Field(alias='eventLog')

custom_dimension class-attribute

custom_dimension: Optional[str] = Field(
    alias="customDimension"
)

AnalysisPackageTransport

Bases: PyCelonisBaseModel

analysis class-attribute

analysis: Optional[AnalysisTransport] = Field(
    alias="analysis"
)

kpis class-attribute

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

draft class-attribute

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

data_model_id class-attribute

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

knowledge_model_key class-attribute

knowledge_model_key: Optional[str] = Field(
    alias="knowledgeModelKey"
)

next_draft_creation_date_time class-attribute

next_draft_creation_date_time: Optional[datetime] = Field(
    alias="nextDraftCreationDateTime"
)

change_default_event_log class-attribute

change_default_event_log: Optional[bool] = Field(
    alias="changeDefaultEventLog"
)

event_log class-attribute

event_log: Optional[str] = Field(alias='eventLog')

custom_dimension class-attribute

custom_dimension: Optional[str] = Field(
    alias="customDimension"
)

AnalysisTransport

Bases: PyCelonisBaseModel

permissions class-attribute

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

id class-attribute

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

tenant_id class-attribute

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

name class-attribute

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

key class-attribute

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

description class-attribute

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

deleted class-attribute

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

transport_id class-attribute

transport_id: Optional[str] = Field(alias='transportId')

last_published_draft_id class-attribute

last_published_draft_id: Optional[str] = Field(
    alias="lastPublishedDraftId"
)

auto_save_id class-attribute

auto_save_id: Optional[str] = Field(alias='autoSaveId')

process_id class-attribute

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

create_date class-attribute

create_date: Optional[datetime] = Field(alias='createDate')

favourite class-attribute

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

content_id class-attribute

content_id: Optional[str] = Field(alias='contentId')

content_version class-attribute

content_version: Optional[int] = Field(
    alias="contentVersion"
)

tags class-attribute

tags: Optional[List[Optional[Tag]]] = Field(alias='tags')

application_id class-attribute

application_id: Optional[str] = Field(alias="applicationId")

global_app class-attribute

global_app: Optional[bool] = Field(alias='globalApp')

public_link class-attribute

public_link: Optional[bool] = Field(alias='publicLink')

last_published_date class-attribute

last_published_date: Optional[datetime] = Field(
    alias="lastPublishedDate"
)

last_published_user class-attribute

last_published_user: Optional[str] = Field(
    alias="lastPublishedUser"
)

parent_object_id class-attribute

parent_object_id: Optional[str] = Field(
    alias="parentObjectId"
)

published_draft_id class-attribute

published_draft_id: Optional[str] = Field(
    alias="publishedDraftId"
)

folder_id class-attribute

folder_id: Optional[str] = Field(alias='folderId')

object_id class-attribute

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

application class-attribute

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

DraftTransport

Bases: PyCelonisBaseModel

id class-attribute

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

title class-attribute

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

document class-attribute

document: Optional[Any] = Field(alias='document')

last_change_date class-attribute

last_change_date: Optional[datetime] = Field(
    alias="lastChangeDate"
)

last_change_user_id class-attribute

last_change_user_id: Optional[str] = Field(
    alias="lastChangeUserId"
)

last_change_user_name class-attribute

last_change_user_name: Optional[str] = Field(
    alias="lastChangeUserName"
)

locked_until_date class-attribute

locked_until_date: Optional[datetime] = Field(
    alias="lockedUntilDate"
)

source_id class-attribute

source_id: Optional[str] = Field(alias='sourceId')

KpiTransport

Bases: PyCelonisBaseModel

id class-attribute

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

name class-attribute

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

description class-attribute

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

template class-attribute

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

parameters class-attribute

parameters: Optional[Any] = Field(alias='parameters')

parameter_count class-attribute

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

source class-attribute

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

unit class-attribute

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

value_format class-attribute

value_format: Optional[str] = Field(alias='valueFormat')

Tag

Bases: PyCelonisBaseModel

name class-attribute

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

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

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

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
)