audit_list( session, id, context, date, [filter], [max_res=1000] , [offset=0])

All

SOAP, REST (Since API Version 2.7.30)

Input parameters:

• session: is the session token obtained in the session_init() call

• id: CASE or USER reference (depending on the context value)

• context: Possible values:

  • "CASE": The list of audit records will correspond to operations that affected the selected CASE

  • "USER": The list of audit records will correspond to operations executed by the selected USER

• date: date in the active session local timezone in format YYYY-MM-DD to extract the list of audit entries in this day for the user/patient

• filter: JSON string with options to filter the list of audit records returned. See AUDIT Filter options

• max_res: maximum number of results

• offset: offset of the first element (for pagination)

Output parameters:

• result: List of audit records and related users

  • audits: list of audit records. For each record the information provided is:

    • ref: audit log reference. Can be used to retrieve extended information with the API function audit_get (session, id)

    • object: type of object affected (“TASK”, “ADMISSION”, etc.)

    • method: name of the API function executed

    • type: type of action executed (“get”, “set”, “insert”, “delete”, “restore”, “purge”)

    • date: date of the record in the active session local timezone

    • user: Information about the USER/CASE affected (depends on the context selected)

      • ref: reference of the USER/CASE affected (depends on the context selected)

      • nickname: name of the USER/CASE affected (depends on the context selected)

  • users: list of users that generated the audit records. For each USER the information provided is:

    • ref: reference of the USER

    • nickname: name of the USER

• ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

• ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to …