Function prototype	background_logs ($session, [max], [from])
API Version	2.7.29 and higher
Supported interfaces	SOAP, REST

Description

Retrieves the logs generated by the execution of the background processes

The background processes executed by the SYSTEM DAEMON: AUTOMATED PROCESSES generate logs that can be tracked by this function. The size logs stored have a maximum size defined by a configuration parameter (see WEB SERVICES CONFIGURATION )

Required permissions: The active user must be super-administrator. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.

Input parameters:

session: is the session token obtained in the session_init() call
max: maximum number of logs to retrieve. If not provided, all the logs in the internal buffer will be returned. The function always returns the logs ordered by date ascending.
from: Optionally it is possible to provide a reference of a log previously loaded. This way you can request the logs at a a certain moment and then repeat the operation to retrieve only the new logs from the last one.

Output parameters:

result: List of log entries. Each log entry contains the following information
- ref: reference of the log
- date: log date (in the current session timezone)
- msg: log message
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

Request example

background_logs(“LCAAAAAAAAAAAA”)

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

ERROR CODE

ERROR CODE
INVALID_TOKEN	The session token provided is not valid
INSUFFICIENT_PRIVILEGES	The session user does not have the necessary privileges to request this action