backend.api.modules.temporal_profile_router¶

Contains the routes for temporal conformance checking.

Attributes¶

`TableType`
`GraphType`
`EndpointReturnType`
`router`
`MODULE_NAME`

Functions¶

`compute_temporal_conformance_result`(, ...)	Computes the temporal conformance result and stores it.
`get_temporal_conformance_result`(→ EndpointReturnType)	Retrieves the temporal conformance result for a given job ID.

Module Contents¶

type backend.api.modules.temporal_profile_router.TableType = Dict[str, List[str] | List[List[Any]]]¶

type backend.api.modules.temporal_profile_router.GraphType = Dict[str, List[Dict[str, Any]]]¶

type backend.api.modules.temporal_profile_router.EndpointReturnType = Dict[str, List[TableType] | List[GraphType]]¶

backend.api.modules.temporal_profile_router.router¶

backend.api.modules.temporal_profile_router.MODULE_NAME = 'temporal'¶

async backend.api.modules.temporal_profile_router.compute_temporal_conformance_result(background_tasks: fastapi.BackgroundTasks, request: fastapi.Request, zeta: float = Query(0.5, description='Zeta value for temporal profile conformance checking', gt=0.0), celonis_connection: backend.celonis_connection.celonis_connection_manager.CelonisConnectionManager = Depends(get_celonis_connection)) → Dict[str, str]¶

Computes the temporal conformance result and stores it.

Parameters:

background_tasks – The background tasks manager.
request – The FastAPI request object.
zeta – The zeta value used for temporal profile conformance checking.
celonis_connection – The Celonis connection manager instance.

Returns:

A dictionary containing the job ID of the scheduled task.

async backend.api.modules.temporal_profile_router.get_temporal_conformance_result(job_id: str, request: fastapi.Request) → EndpointReturnType¶

Retrieves the temporal conformance result for a given job ID.

This result is expected to be a list of lists of tuples, representing the raw output from TemporalProfile.get_temporal_conformance_result().

Parameters:

job_id – The ID of the job for which to retrieve the result.
request – The FastAPI request object.

Returns:

The temporal conformance result in the form of table and graph data.

Raises:

HTTPException – If the job is not found or if the result is not available.