OpenBackupIndex

July 21, 2025

This API is used to check if File Viewer is enabled and if the index file exists and not open in another session.

URL

https://CBS.EXAMPLE.COM/obs/api/json/2/OpenBackupIndex.do

Available Since Version: 10.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.
BackupSetID String ID of the backup set.
DestinationID String Destination ID of the backup set.
Return Values
Key Type Description
Status String "OK" or "Error"
SessionID String ID that is associated with the open index file.
AlreadOpenedByOtherAPI Boolean True if already opened by a previous API call.
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
Examples

Example 1: No open backup index session

INPUT

{
    "SysUser":"system",
    "SysPwd":"system1",
    "LoginName":"user",
    "BackupSetID":"1747807584674",
    "DestinationID":"1747807607337"
}

OUTPUT

{
    "Status": "OK",
    "Data": {
        "SessionID": "92518cbc-8805-4dcd-b4f8-f2ac3a75ad9e"
    }
}

Example 2: Backup index is still open in another session

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"user",
	"BackupSetID":"1747807584674",
    "DestinationID":"1747807607337"
}

OUTPUT

{
    "Status": "Error",
    "Message": "Cannot proceed with this operation. The index file is opened in another session.",
    "ExptType": "com.ahsay.obs.core.cloud.b"
}

Example 3: File Viewer is not enabled

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"user",
	"BackupSetID":"1747808227820",
    "DestinationID":"1747808445390"
}

OUTPUT

{
    "Status": "Error",
    "Message": "File viewer is disabled.",
    "ExptType": "java.lang.Exception"
}
Documentation