backend.api.setup

Contains a router for the setup of the application.

It contains several ‘utility’ endpoints that are used in the setup of the application and the general configuration for event logs.

Attributes

router

ENV_PATH

LOCK_PATH

Functions

celonis_credentials(credentials)

Saves the Celonis credentials to the .env file.

get_column_names(→ Dict[str, List[str]])

Provides the column names of the current log.

Module Contents

backend.api.setup.router
backend.api.setup.ENV_PATH
backend.api.setup.LOCK_PATH
async backend.api.setup.celonis_credentials(credentials: backend.api.models.schemas.setup_models.CelonisCredentials)

Saves the Celonis credentials to the .env file.

Parameters:

credentials – The Celonis credentials to be saved. This should be a CelonisCredentials object.

Returns:

A dictionary containing a message indicating the success of the operation.

async backend.api.setup.get_column_names(request: fastapi.Request) → Dict[str, List[str]]

Provides the column names of the current log.

Parameters:

request – The FastAPI request object. This is used to access the app state and retrieve the current log columns.

Returns:

A dictionary containing the column names of the current log.

Raises:

  • HTTPException – If no log columns are found in the app state, a 400 error is raised

  • with a message indicating that no log columns were found. The user should –

  • upload a log first. –