GetRestoreJobReport

July 21, 2025

This API can be used to retrieve a detailed report of a restore job.

The settings can be found on the AhsayCBS web console at:

  • Monitoring > Backup / Restore Logs > Restore Jobs

URL

https://CBS.EXAMPLE.COM/obs/api/json/GetRestoreJobReport.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Username of the backup user.
Owner String Owner of the backup user.
BackupSetID String ID of the backup set. Obtainable by calling the GetBackupSet API.
JobID String ID of the restore job. Obtainable from the client restore log or in the user how at: %Clientprofile%\.obm\log\%backupset_id%\Restore\YYYY-MM-DD\YYYY-MM-DD-hh-mm-ss.log or %Userhome%\username\pdf\restore\%backupset_id%\YYYY-MM-DD\YYYY-MM-DD-hh-mm-ss.pdf. Where the JobID is YYYY-MM-DD-hh-mm-ss (e.g. file name of the .log / .pdf file).
Return Values
Key Type Description
Status String "OK" or "Error"
Data JSON Object See JSON Objects.
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, it appears only if status is "Error".
JSON Objects

Report

Key Type Description
ID String ID of the report.
StartTime Long Start time of the restore job.
EndTime Long End time of the restore job.
FromIp String Restore from specified IP address.
DestinationID String ID of the destination.
Status String Status of the restore. Can be one of the following: RESTORE_STOP_SUCCESS_WITH_ERROR, RESTORE_STOP_SUCCESS_WITH_WARNING, RESTORE_STOP_SUCCESS, RESTORE_STOP_BY_USER or RESTORE_STOP_BY_ERROR.
TotalFileCount Long Total number of files restored.
TotalFileSize Long Total size of files restored.
Logs Array of Log Array list of logs.

Log

Key Type Description
Type String Type of log, can either be file or info.
StartTime Long Start time of the restore job.
EndTime Long End time of the restore job.
Name String Name of the restore job.
FileSize Long Size of the file.
UncompressedSize Long Size of the uncompressed file.
LastModified Long Date of last modification.
Message String This key exists only if "Type" is "info".
LogType String This key exists only if "Type" is "info".
Timestamp String This key exists only if "Type" is "info". In yyyy/MM/dd hh:mm:ss format.
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"BackupSetID":"1687755057644",
	"JobID":""
}

OUTPUT

{
	"Status":"OK",
	"Data":{
		"Status":"RESTORE_STOP_SUCCESS",
		"EndTime":"2024-06-26 14:27;08",
		"TotalFileCount":0,
		"StartTime":"2024-06-26 14:26:59",
		"TotalFileSize":0,
		"Logs":[
			{
				"Type":"start"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_CDP.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \”C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_CDP_Filter.html\” exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_CloudFile_Source.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_File_Source.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_IBMDomino_Encryption.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_IBMDomino_Source.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_IBMDomino_WinUserAuthen.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			},
			{
				"Type":"info",
				"Message":"Same file \"C:\\Users\\Administrator\\Desktop\\Help Files\\ACB\\BS_Create_IBMNotes_Dest.html\" exists already.",
				"LogType":"info",
				"Timestamp":"2024/06/26 14:27:03"
			}
		],
		"FromIp":"10.3.121.64",
		"DestinationID":"1687755083984"
	}
}
Documentation