Skip to content

Index

Module to interact with EMS services.

This module serves as entry point to all high-level functionality within the EMS.

get_celonis 

get_celonis(
    base_url=None,
    api_token=None,
    key_type=None,
    user_agent=None,
    connect=True,
    permissions=True,
    check_if_outdated=True,
    retries=0,
    delay=1,
    **kwargs
)

Get a Celonis object.

Parameters:

  • base_url (typing.Optional[str]) –

    Celonis base URL.

  • api_token (typing.Optional[str]) –

    Celonis API token.

  • key_type (typing.Optional[typing.Union[str, KeyType]]) –

    KeyType of API token. One of [APP_KEY, USER_KEY] or pycelonis_core.client.KeyType.

  • user_agent (typing.Optional[str]) –

    Session header value for User-Agent.

  • connect (bool) –

    If True connects to Celonis on initialization (initial request to check if the token & key_type combination is correct).

  • permissions (bool) –

    If True provides permission information.

  • check_if_outdated (bool) –

    If true checks if current pycelonis version is outdated.

  • retries (int) –

    Number of total retries if request is failing.

  • delay (int) –

    Delay between retries in seconds.

Returns: