PM4Py-WS Log Management Services

PM4Py-WS Log Management Services

(POST JSON) /uploadLog

Permits to upload a XES log to the services.

URI parameters:

session => the ID of the session that the user can use to communicate with the server

POST content (JSON): a JSON with the following properties:

  • filename: string that represents the name of such log
  • base64: base64 encoded string that represents the content of the log

Returns:

If the session is valid and the user has the permission to upload a log in the system, the log is loaded in the system and a JSON is returned:

  • status: the status of the operation (OK)

Otherwise, a JSON containing the following values:

  • status: the status of the operation (FAIL)
(GET) /downloadCsvLog

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process that is downloaded

Returns:

If the session is valid, the user has visibility on such log and has the permission to download the log, then a JSON containing:

content => the content of the log in CSV format

Otherwise a JSON containing:

content => empty

(GET) /downloadXesLog

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process that is downloaded

Returns:

If the session is valid, the user has visibility on such log and has the permission to download the log, then a JSON containing:

content => the content of the log in XES format

Otherwise a JSON containing:

content => empty

 

(GET) /deleteEventLog

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process that is removed

Returns:

If the session is valid, the user has visibility on such log and has the permission to delete the log, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

 

(GET) /getUserEventLogVisibility

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

sorted_users => list of users in the system (obtained from database tables)

sorted_logs => list of logs in the system

user_log_visibility => map that has as first key the user, as second key one of the log, and a boolean value saying if the user has visibility on the log or not

Otherwise a JSON containing:

success => False

 

(GET) /REMOVEUSERLOGVISIBILITY

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log visibility changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

 

(GET) /addEUSERLOGVISIBILITY

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log visibility changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

 

(GET) /REMOVEUSERLOGREMOVABLE

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log removability changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

 

(GET) /addEUSERLOGREMOVABLE

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log removability changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

(GET) /REMOVEUSERLOGDOWNLOADABLE

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log downloadability changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False

 

(GET) /addEUSERLOGDOWNLOADABLE

URI parameters:

session => the ID of the session that the user can use to communicate with the server

process => the name of the process

user => the name of the user that should have the permissions on log downloadability changed

Returns:

If the session is valid, the user of the session is an admin, then a JSON containing:

success => True

Otherwise a JSON containing:

success => False