Fetch DB2 BackupSet Properties

This operation returns all properties of a DB2 backupset.

Path Parameters

• BackupsetID integer required

  ID of the backupset

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• D B2 Backupset Properties

---

Schema

• backupsetProperties object[]

  All properties of the backupset

  modifiedTime integer

  applicationSize integer

  totalBackupSize integer

  lastBackupTime integer

  firstBackupTime integer

  scIdxEnabled integer

  sizeOnMedia integer

  dedupeRatio integer

  securityAssociations object

  ownerAssociations object

  tagWithCompany object

  providerId integer

  providerDomainName string

  indexSettings object

  overrideIndexPruning integer

  isPruningEnabled integer

  currentIndexServer object

  qualifyingIndexServers object[]

  clientId integer

  clientName string

  content object[]

  backupsetSecurity object

  associatedUserGroups object[]

  details about user group

  userGroupId integer

  _type_ string

  userGroupName string

  advancedPrivacySettings object

  isPasskeyFeatureEnabled boolean

  authType string

  isPrivacyFeatureEnabled boolean

  passkeySettings object

  enableAuthorizeForRestore boolean

  expirationTime object

  time integer

  ownerCapabilities object

  db2BackupSet object

  Backupset specific properties

  dB2DBStatus integer

  dB2AutoStorage boolean

  useSQLConnect boolean

  dB2CatalogPartitionNumber integer

  dB2DefaultIndexSP object

  storagePolicyName string

  storagePolicyId integer

  dB2DefaultCommandSP object

  storagePolicyName string

  storagePolicyId integer

  db2SqlConnectInfo object

  userName string

  planEntity object

  planType integer

  planName string

  planSubtype integer

  planId integer

  commonBackupSet object

  Backupset common properties

  dataMigratorILMCLASS boolean

  newBackupSetName string

  onDemandBackupset boolean

  slaStatus string

  isDeleted boolean

  isFanInBackupSet boolean

  isLegalHoldBackupset boolean

  decompressData boolean

  isNasTurboBackupSet boolean

  isArchivingEnabled boolean

  isWildCardContentBackupSet boolean

  cDRFSDMBackupset boolean

  userDescription string

  associatedsubclientPolicy integer

  isDedupBackupset boolean

  isMyBackupSet boolean

  siloCopyId integer

  isDefaultBackupSet boolean

  isHidden boolean

  isMining boolean

  isUSeDCForBackup boolean

  backupSetEntity object

  Backup set general properties

  clientName string

  instanceName string

  displayName string

  backupsetId integer

  _type_ string

  instanceId integer

  backupsetGUID string

  clientId integer

  appName string

  backupsetName string

  applicationId integer

  entityInfo object

  companyId integer

  companyName string

  multiCommcellId integer

{
  "backupsetProperties": [
    {
      "modifiedTime": 0,
      "applicationSize": 0,
      "totalBackupSize": 0,
      "lastBackupTime": 0,
      "firstBackupTime": 0,
      "scIdxEnabled": 0,
      "sizeOnMedia": 0,
      "dedupeRatio": 0,
      "securityAssociations": {
        "ownerAssociations": {},
        "tagWithCompany": {
          "providerId": 0,
          "providerDomainName": "string"
        }
      },
      "indexSettings": {
        "overrideIndexPruning": 0,
        "isPruningEnabled": 0,
        "currentIndexServer": {},
        "qualifyingIndexServers": [
          {
            "clientId": 0,
            "clientName": "string"
          }
        ]
      },
      "content": [
        {}
      ],
      "backupsetSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 0,
            "_type_": "string",
            "userGroupName": "string"
          }
        ],
        "advancedPrivacySettings": {
          "isPasskeyFeatureEnabled": true,
          "authType": "string",
          "isPrivacyFeatureEnabled": true,
          "passkeySettings": {
            "enableAuthorizeForRestore": true,
            "expirationTime": {
              "time": 0
            }
          }
        },
        "ownerCapabilities": {}
      },
      "db2BackupSet": {
        "dB2DBStatus": 0,
        "dB2AutoStorage": true,
        "useSQLConnect": true,
        "dB2CatalogPartitionNumber": 0,
        "dB2DefaultIndexSP": {
          "storagePolicyName": "string",
          "storagePolicyId": 0
        },
        "dB2DefaultCommandSP": {
          "storagePolicyName": "string",
          "storagePolicyId": 0
        },
        "db2SqlConnectInfo": {
          "userName": "string"
        }
      },
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "commonBackupSet": {
        "dataMigratorILMCLASS": true,
        "newBackupSetName": "string",
        "onDemandBackupset": true,
        "slaStatus": "string",
        "isDeleted": true,
        "isFanInBackupSet": true,
        "isLegalHoldBackupset": true,
        "decompressData": true,
        "isNasTurboBackupSet": true,
        "isArchivingEnabled": true,
        "isWildCardContentBackupSet": true,
        "cDRFSDMBackupset": true,
        "userDescription": "string",
        "associatedsubclientPolicy": 0,
        "isDedupBackupset": true,
        "isMyBackupSet": true,
        "siloCopyId": 0,
        "isDefaultBackupSet": true,
        "isHidden": true,
        "isMining": true,
        "isUSeDCForBackup": true
      },
      "backupSetEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": "string",
        "instanceId": 0,
        "backupsetGUID": "string",
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 0,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      }
    }
  ]
}

{
  "backupsetProperties": [
    {
      "modifiedTime": 1705300417,
      "applicationSize": 0,
      "totalBackupSize": 0,
      "lastBackupTime": 0,
      "firstBackupTime": 0,
      "scIdxEnabled": 0,
      "sizeOnMedia": 0,
      "dedupeRatio": 0,
      "securityAssociations": {
        "ownerAssociations": {},
        "tagWithCompany": {
          "providerId": 0,
          "providerDomainName": "Commcell"
        }
      },
      "indexSettings": {
        "overrideIndexPruning": 0,
        "isPruningEnabled": 1,
        "currentIndexServer": {},
        "qualifyingIndexServers": [
          {},
          {
            "clientId": 168,
            "clientName": "winter11"
          }
        ]
      },
      "content": [
        {}
      ],
      "backupsetSecurity": {
        "associatedUserGroups": [
          {
            "userGroupId": 1,
            "_type_": "USERGROUP_ENTITY",
            "userGroupName": "master"
          }
        ],
        "advancedPrivacySettings": {
          "isPasskeyFeatureEnabled": false,
          "authType": "USE_LOGIN",
          "isPrivacyFeatureEnabled": false,
          "passkeySettings": {
            "enableAuthorizeForRestore": false,
            "expirationTime": {
              "time": 0
            }
          }
        },
        "ownerCapabilities": {}
      },
      "db2BackupSet": {
        "dB2DBStatus": 0,
        "dB2AutoStorage": true,
        "useSQLConnect": false,
        "dB2CatalogPartitionNumber": 0,
        "dB2DefaultIndexSP": {
          "storagePolicyName": "a_default_winter11",
          "storagePolicyId": 44
        },
        "dB2DefaultCommandSP": {
          "storagePolicyName": "",
          "storagePolicyId": 0
        },
        "db2SqlConnectInfo": {
          "userName": ""
        }
      },
      "planEntity": {
        "planType": 2,
        "planName": "a_default_winter11",
        "planSubtype": 33554437,
        "planId": 22
      },
      "commonBackupSet": {
        "dataMigratorILMCLASS": false,
        "newBackupSetName": "TEMP",
        "onDemandBackupset": false,
        "slaStatus": "EXCLUDED_SLA",
        "isDeleted": false,
        "isFanInBackupSet": false,
        "isLegalHoldBackupset": false,
        "decompressData": false,
        "isNasTurboBackupSet": false,
        "isArchivingEnabled": false,
        "isWildCardContentBackupSet": false,
        "cDRFSDMBackupset": false,
        "userDescription": "",
        "associatedsubclientPolicy": 0,
        "isDedupBackupset": false,
        "isMyBackupSet": false,
        "siloCopyId": 0,
        "isDefaultBackupSet": false,
        "isHidden": false,
        "isMining": false,
        "isUSeDCForBackup": false
      },
      "backupSetEntity": {
        "clientName": "vikram-manual-8",
        "instanceName": "db2inst9",
        "displayName": "vikram-manual-8",
        "backupsetId": 945,
        "_type_": "BACKUPSET_ENTITY",
        "instanceId": 753,
        "backupsetGUID": "619A592E-4888-4B97-B9CB-D54D021645E8",
        "clientId": 203,
        "appName": "DB2",
        "backupsetName": "TEMP",
        "applicationId": 62,
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      }
    }
  ]
}

Bad Request

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Invalid Backupset Name is specified. Please provide the correct Backupset name.",
  "errorCode": 587204419
}

Loading...