get_celonis
get_celonis(url=None, api_token=None, key_type=None, return_object=False, verify_ssl=True, read_only=False, user_agent='pycelonis/1.6.1', timeout=120, total_retry=0, backoff_factor=0, cookie=None, connect=True, permissions=True, **kwargs)
¶
Get a Celonis object or pass a fully qualified URL to get a specific
Celonis Resource object, e.g. https://<team>.<realm>.celonis.cloud/package-manager/api/spaces/{space_id}
to get
the Space object directly.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url |
str |
Celonis base URL. |
None |
api_token |
str |
Celonis API token. |
None |
key_type |
Union[str, KeyType] |
KeyType of API token. One of [ |
None |
return_object |
bool |
Weather or not to return the requested object. |
False |
verify_ssl |
bool |
Requiring requests to verify the TLS certificate at the remote end. |
True |
read_only |
bool |
If True only GET methods are allowed, set to False to enable PUT, POST and DELETE methods. |
False |
user_agent |
str |
Session header value for |
'pycelonis/1.6.1' |
timeout |
int |
How long to wait for the server to send data before giving up
(in seconds, 300 for data push/pull, max 600). |
120 |
total_retry |
int |
Total number of retries (by default disabled, max. 10). |
0 |
backoff_factor |
float |
Factor to apply between retry attempts after the second try (by default disabled). |
0 |
cookie |
str |
Session header value for |
None |
connect |
bool |
If True connects to Celonis on initialization
(initial request to check if the |
True |
permissions |
bool |
If True provides permission information. |
True |
Returns:
Type | Description |
---|---|
Any |
The Celonis API object. |