Get table group properties

Select

SaaS

Customer Managed

This API call fetches the table group properties

Path Parameters

Subclient_id string required
ID of subclient

Responses

application/json

Schema
Example (from schema)

Schema

subClientProperties object[]
status integer
useLocalContent boolean
useLocalArchivalRules boolean
canChangeEncryptionSetting boolean
planEntity object
planType integer
planName string
planSubtype integer
planId integer
cassandraProps object
taPlanEntity object
splunkProps object
proxyClient object
clientId integer
clientName string
dcPlanEntity object
subClientEntity object
clientName string
instanceName string
displayName string
backupsetId integer
_type_ integer
commCellName string
instanceId integer
csGUID string
subclientGUID string
subclientId integer
clientId integer
appName string
backupsetName string
applicationId integer
Default value: 134
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
dfsSubclientProp object
cloudAppsSubClientProp object
instanceType integer
dynamoDBSubclient object
temporaryReadThroughput integer
region object
commonProperties object
nextBackupTime integer
slaStatus integer
isAdAppAwareSubclient boolean
disableArchivingTurboRule boolean
firstBackupTime integer
lastBackupTime integer
indexingBackupSubClient boolean
allowVssForSnapbackup boolean
isActivityDisabledFromPolicy boolean
isETCDSubclient boolean
enableBackupAfterDelay boolean
runAs integer
slaCategoryDescription string
onBoardCompanyId integer
sizeOnMedia integer
enableBackup boolean
encryptionFlag integer
numberOfBackupStreams integer
idaType integer
runTrueUpJobAfterDays integer
totalBackupSize integer
dedupeRatio integer
isTrueUpOptionEnabled boolean
slaCategory integer
subClientPropertiesFlag integer
lastBackupSize integer
allowMultipleDataReaders boolean
securityAssociations object
ownerAssociations object
tagWithCompany object
providerId integer
providerDomainName string
associatedSnapShotSCId object
_type_ integer
snapCopyInfo object
IsOracleSposDriverEnabled boolean
isRMANEnableForTapeMovement boolean
useProxyForSQLIntegrity object
sybaseUser object
snapToTapeSelectedEngine object
_type_ integer
sqlUser object
vmApplicationUser object
snapToTapeProxyToUse object
_type_ integer
quiesceImpersonateUser object
separateProxyForSnapToTape object
_type_ integer
sshKey object
configuredSybaseInstance object
_type_ integer
subclientPolicy object
_type_ integer
subclientPolicyName string
impersonateUserCredentialinfo object
credentialId integer
credentialName string
enableBackupAtDateTime object
TimeZoneID integer
time integer
turboNASClient object
_type_ integer
prepostProcess object
runPostScan integer
runPostBackup integer
runPostLog integer
prepostUserName object
security object
associatedUserGroups object[]
userGroupId integer
_type_ integer
userGroupName string
advancedPrivacySettings object
isPasskeyFeatureEnabled boolean
authType integer
isPrivacyFeatureEnabled boolean
passkeySettings object
enableAuthorizeForRestore boolean
expirationTime object
time integer
ownerCapabilities object
storageDevice object
networkAgents integer
softwareCompression integer
throttleNetworkBandwidth integer
dataBackupStoragePolicy object
_type_ integer
storagePolicyName string
storagePolicyId integer
deDuplicationOptions object
enableDeduplication boolean
generateSignature integer
logBackupStoragePolicy object
_type_ integer
performanceMode object
perfSPName string
multiplexingValid boolean
enableMultiplexing boolean
perfCopyName string
perfClientName string
streamsOverMux boolean
pipelineBufferSize integer
numOfPipelineBuffers integer
muxFactor integer
lookAheadReaderSlots integer
perfCRCDetails object[]
crcOverMedia boolean
perfMaId integer
crcOverNetwork boolean
perfMa string
UNCScriptCredentialinfo object
credentialId integer
credentialName string
vmBackupValidationSettings object
isAppValidationEnabled boolean
backupValidationThreadCount integer
subTaskId integer
isCustomAppEnabled boolean
runAsDevTestGroup boolean
taskId integer
useSourceVMEsxToMount boolean
uncScriptImpersonateUser object
userName string
prepostCredentialinfo object
credentialId integer
credentialName string
associatedPolicy object
subclientPolicyId integer
guestCredentialinfo object
credentialId integer
credentialName string
analyticsSubclientProp object
cloudDbContent object
children object[]
path string
negation boolean
displayName string
name string
allOrAnyChildren boolean
type integer

{
  "subClientProperties": [
    {
      "status": 0,
      "useLocalContent": true,
      "useLocalArchivalRules": true,
      "canChangeEncryptionSetting": true,
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cassandraProps": {},
      "taPlanEntity": {},
      "splunkProps": {},
      "proxyClient": {
        "clientId": 0,
        "clientName": "string"
      },
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "commCellName": "string",
        "instanceId": 0,
        "csGUID": "string",
        "subclientGUID": "string",
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 134,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "cloudAppsSubClientProp": {
        "instanceType": 0,
        "dynamoDBSubclient": {
          "temporaryReadThroughput": 0
        }
      },
      "region": {},
      "commonProperties": {
        "nextBackupTime": 0,
        "slaStatus": 0,
        "isAdAppAwareSubclient": true,
        "disableArchivingTurboRule": true,
        "firstBackupTime": 0,
        "lastBackupTime": 0,
        "indexingBackupSubClient": true,
        "allowVssForSnapbackup": true,
        "isActivityDisabledFromPolicy": true,
        "isETCDSubclient": true,
        "enableBackupAfterDelay": true,
        "runAs": 0,
        "slaCategoryDescription": "string",
        "onBoardCompanyId": 0,
        "sizeOnMedia": 0,
        "enableBackup": true,
        "encryptionFlag": 0,
        "numberOfBackupStreams": 0,
        "idaType": 0,
        "runTrueUpJobAfterDays": 0,
        "totalBackupSize": 0,
        "dedupeRatio": 0,
        "isTrueUpOptionEnabled": true,
        "slaCategory": 0,
        "subClientPropertiesFlag": 0,
        "lastBackupSize": 0,
        "allowMultipleDataReaders": true,
        "securityAssociations": {
          "ownerAssociations": {},
          "tagWithCompany": {
            "providerId": 0,
            "providerDomainName": "string"
          }
        },
        "associatedSnapShotSCId": {
          "_type_": 0
        },
        "snapCopyInfo": {
          "IsOracleSposDriverEnabled": true,
          "isRMANEnableForTapeMovement": true,
          "useProxyForSQLIntegrity": {},
          "sybaseUser": {},
          "snapToTapeSelectedEngine": {
            "_type_": 0
          },
          "sqlUser": {},
          "vmApplicationUser": {},
          "snapToTapeProxyToUse": {
            "_type_": 0
          },
          "quiesceImpersonateUser": {},
          "separateProxyForSnapToTape": {
            "_type_": 0
          },
          "sshKey": {},
          "configuredSybaseInstance": {
            "_type_": 0
          }
        },
        "subclientPolicy": {
          "_type_": 0,
          "subclientPolicyName": "string"
        },
        "impersonateUserCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "enableBackupAtDateTime": {
          "TimeZoneID": 0,
          "time": 0
        },
        "turboNASClient": {
          "_type_": 0
        },
        "prepostProcess": {
          "runPostScan": 0,
          "runPostBackup": 0,
          "runPostLog": 0,
          "prepostUserName": {}
        },
        "security": {
          "associatedUserGroups": [
            {
              "userGroupId": 0,
              "_type_": 0,
              "userGroupName": "string"
            }
          ],
          "advancedPrivacySettings": {
            "isPasskeyFeatureEnabled": true,
            "authType": 0,
            "isPrivacyFeatureEnabled": true,
            "passkeySettings": {
              "enableAuthorizeForRestore": true,
              "expirationTime": {
                "time": 0
              }
            }
          },
          "ownerCapabilities": {}
        },
        "storageDevice": {
          "networkAgents": 0,
          "softwareCompression": 0,
          "throttleNetworkBandwidth": 0,
          "dataBackupStoragePolicy": {
            "_type_": 0,
            "storagePolicyName": "string",
            "storagePolicyId": 0
          },
          "deDuplicationOptions": {
            "enableDeduplication": true,
            "generateSignature": 0
          },
          "logBackupStoragePolicy": {
            "_type_": 0
          },
          "performanceMode": {
            "perfSPName": "string",
            "multiplexingValid": true,
            "enableMultiplexing": true,
            "perfCopyName": "string",
            "perfClientName": "string",
            "streamsOverMux": true,
            "pipelineBufferSize": 0,
            "numOfPipelineBuffers": 0,
            "muxFactor": 0,
            "lookAheadReaderSlots": 0,
            "perfCRCDetails": [
              {
                "crcOverMedia": true,
                "perfMaId": 0,
                "crcOverNetwork": true,
                "perfMa": "string"
              }
            ]
          }
        },
        "UNCScriptCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "vmBackupValidationSettings": {
          "isAppValidationEnabled": true,
          "backupValidationThreadCount": 0,
          "subTaskId": 0,
          "isCustomAppEnabled": true,
          "runAsDevTestGroup": true,
          "taskId": 0,
          "useSourceVMEsxToMount": true,
          "uncScriptImpersonateUser": {
            "userName": "string"
          }
        },
        "prepostCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "associatedPolicy": {
          "subclientPolicyId": 0
        },
        "guestCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        }
      },
      "analyticsSubclientProp": {},
      "cloudDbContent": {
        "children": [
          {
            "path": "string",
            "negation": true,
            "displayName": "string",
            "name": "string",
            "allOrAnyChildren": true,
            "type": 0
          }
        ]
      }
    }
  ]
}

Not Found

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

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

{
  "errorMessage": "Input XML has invalid subclient name in association.",
  "errorCode": 587204334
}

Get table group properties​

Get table group properties