GET /api/v1/getActivityLog.jsp

Get activity log that contains records about jobs (completed and still running).

Parameters:

The following parameters are optional filters for corresponding fields of the activity log record:

• appId - application id in which the job is started
• title - job title (substring search)
• status - job status (exact search; see values below)
• initType - initialization type (exact search; see values below)
• before - return only jobs started before or equal the time specified; specified in the time zone of the user who makes the API call (required format: yyyy-MM-dd HH:mm:ss.SSS)
• after - return only jobs started after the time specified; specified in the time zone of the user who makes the API call (required format: yyyy-MM-dd HH:mm:ss.SSS)
• userId - id of the user who started the job
• limit - number of records to return (default: 100)

Example:

curl -i -X GET "<path_to_infolink>/api/v1/getActivityLog.jsp?apiKey=[your API key]&appId=1&title=Load
                    

Response:

Each record returns the following fields about the job:

• appId - (integer) id of the app in which the job is started (e.g. 9)
• appName - (string) name of the application in which the job is started (e.g. “Tutorials”)
• initType - (string) initialization type (values: “system”, “scheduled”, “api”, “child”, “manual”)
• actuallyRunning - (boolean) is the job currently running (e.g. false),
• title - (string) title of the job (e.g. “Load: Load file FROM S3”)
• userName - (string) name of the user who started the job (e.g. “admin”)
• userId - (integer) id of the user who started the job (e.g. 1)
• result - reserved for system use
• jobId - (string) id of the job (e.g. “25e09ea0-5327-432e-a7ce-cc730a7daa03”)
• opName - (string) operation name (e.g. “LoadTableFromSource”)
• opType - (string) type of the operation (values: “scenario”, “workflow”)
• startTime - (string) start time (e.g. “2024-11-15 10:34:10.525”),
• endTime - (string) end time (e.g. “2024-11-15 10:34:12.274”)
• status - (string) status of the job (values: “completed”, “completedWithError”, “running”, “stopping”, “stopped”)

Example of the response:

{
    "result":[{"appName":"Tutorials-Test-Envs",
    "opType":"scenario","initType":"manual","actuallyRunning":false,
    "title":"Load: Load file FROM S3","userName":"admin","userId":1,"result":null,
    "jobId":"95a6e2ab-aca9-4042-adb9-29eb1f4ba4ff","opName":"LoadTableFromSource",
    "appId":181,"startTime":"2024-11-15 10:34:10.525","endTime":"2024-11-15 10:34:12.274",
    "results":[],"status":"completed"}],
    "status":"success"
}