Get Subclient

Select

SaaS

Customer Managed

Returns a list of subclients

Query Parameters

clientId integer required
Id of the client
backupsetId integer
Id of the backupset
propertyLevel integer
Default value: 5
Property Level of the response

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

filterQueryCount integer
subClientProperties object[]
List of subclients
status integer
useLocalContent boolean
useLocalArchivalRules boolean
hcSubclientProp object
planEntity object
planType integer
planName string
planSubtype integer
planId integer
cassandraProps object
splunkProps object
proxyClient object
dcPlanEntity object
subClientEntity object
Subclient Entity
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
subclientName string
entityInfo object
companyId integer
companyName string
multiCommcellId integer
dfsSubclientProp object
fsSubClientProp object
region object
commonProperties object
slaStatus integer
disableArchivingTurboRule boolean
firstBackupTime integer
lastBackupTime integer
indexingBackupSubClient boolean
jobStartTime integer
isActivityDisabledFromPolicy boolean
enableBackupAfterDelay boolean
runAs integer
slaCategoryDescription string
enableBackup boolean
idaType integer
runTrueUpJobAfterDays integer
isDefaultSubclient boolean
isTrueUpOptionEnabled boolean
slaCategory integer
subClientPropertiesFlag integer
lastBackupSize integer
associatedSnapShotSCId object
_type_ integer
snapCopyInfo object
useDB2ACSInterface 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
impersonateUserCredentialinfo object
credentialId integer
credentialName string
enableBackupAtDateTime object
TimeZoneID integer
time integer
turboNASClient object
_type_ integer
prepostProcess object
prepostUserName object
storageDevice object
dataBackupStoragePolicy object
_type_ integer
storagePolicyName string
storagePolicyId integer
logBackupStoragePolicy object
_type_ integer
performanceMode object
pipelineBufferSize integer
numOfPipelineBuffers integer
muxFactor integer
lookAheadReaderSlots integer
UNCScriptCredentialinfo object
credentialId integer
vmBackupValidationSettings object
backupValidationThreadCount integer
uncScriptImpersonateUser object
prepostCredentialinfo object
credentialId integer
credentialName string
associatedPolicy object
subclientPolicyId integer
guestCredentialinfo object
credentialId integer
description string
analyticsSubclientProp object

{
  "filterQueryCount": 0,
  "subClientProperties": [
    {
      "status": 0,
      "useLocalContent": true,
      "useLocalArchivalRules": true,
      "hcSubclientProp": {},
      "planEntity": {
        "planType": 0,
        "planName": "string",
        "planSubtype": 0,
        "planId": 0
      },
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "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": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "fsSubClientProp": {},
      "region": {},
      "commonProperties": {
        "slaStatus": 0,
        "disableArchivingTurboRule": true,
        "firstBackupTime": 0,
        "lastBackupTime": 0,
        "indexingBackupSubClient": true,
        "jobStartTime": 0,
        "isActivityDisabledFromPolicy": true,
        "enableBackupAfterDelay": true,
        "runAs": 0,
        "slaCategoryDescription": "string",
        "enableBackup": true,
        "idaType": 0,
        "runTrueUpJobAfterDays": 0,
        "isDefaultSubclient": true,
        "isTrueUpOptionEnabled": true,
        "slaCategory": 0,
        "subClientPropertiesFlag": 0,
        "lastBackupSize": 0,
        "associatedSnapShotSCId": {
          "_type_": 0
        },
        "snapCopyInfo": {
          "useDB2ACSInterface": true,
          "useProxyForSQLIntegrity": {},
          "sybaseUser": {},
          "snapToTapeSelectedEngine": {
            "_type_": 0
          },
          "sqlUser": {},
          "vmApplicationUser": {},
          "snapToTapeProxyToUse": {
            "_type_": 0
          },
          "quiesceImpersonateUser": {},
          "separateProxyForSnapToTape": {
            "_type_": 0
          },
          "sshKey": {},
          "configuredSybaseInstance": {
            "_type_": 0
          }
        },
        "subclientPolicy": {
          "_type_": 0
        },
        "impersonateUserCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "enableBackupAtDateTime": {
          "TimeZoneID": 0,
          "time": 0
        },
        "turboNASClient": {
          "_type_": 0
        },
        "prepostProcess": {
          "prepostUserName": {}
        },
        "storageDevice": {
          "dataBackupStoragePolicy": {
            "_type_": 0,
            "storagePolicyName": "string",
            "storagePolicyId": 0
          },
          "logBackupStoragePolicy": {
            "_type_": 0
          },
          "performanceMode": {
            "pipelineBufferSize": 0,
            "numOfPipelineBuffers": 0,
            "muxFactor": 0,
            "lookAheadReaderSlots": 0
          }
        },
        "UNCScriptCredentialinfo": {
          "credentialId": 0
        },
        "vmBackupValidationSettings": {
          "backupValidationThreadCount": 0,
          "uncScriptImpersonateUser": {}
        },
        "prepostCredentialinfo": {
          "credentialId": 0,
          "credentialName": "string"
        },
        "associatedPolicy": {
          "subclientPolicyId": 0
        },
        "guestCredentialinfo": {
          "credentialId": 0
        },
        "description": "string"
      },
      "analyticsSubclientProp": {}
    }
  ]
}

{
  "filterQueryCount": 2,
  "subClientProperties": [
    {
      "status": 8,
      "useLocalContent": false,
      "useLocalArchivalRules": false,
      "hcSubclientProp": {},
      "planEntity": {},
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "jnanlivesync1",
        "instanceName": "DefaultInstanceName",
        "displayName": "jnanlivesync1",
        "backupsetId": 8,
        "_type_": 7,
        "commCellName": "mustardtiger",
        "instanceId": 1,
        "csGUID": "53CF8EBC-16F4-40A8-A8CB-CBC4F2ABC536",
        "subclientGUID": "3D25D977-0220-43D8-BBBB-F485FE39DEC8",
        "subclientId": 7,
        "clientId": 7,
        "appName": "File System",
        "backupsetName": "defaultBackupSet",
        "applicationId": 33,
        "subclientName": "default",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "fsSubClientProp": {},
      "region": {},
      "commonProperties": {
        "slaStatus": 2,
        "disableArchivingTurboRule": false,
        "firstBackupTime": 0,
        "lastBackupTime": 0,
        "indexingBackupSubClient": false,
        "jobStartTime": -1,
        "isActivityDisabledFromPolicy": false,
        "enableBackupAfterDelay": false,
        "runAs": 0,
        "slaCategoryDescription": "No Schedule",
        "enableBackup": true,
        "idaType": 0,
        "runTrueUpJobAfterDays": 0,
        "isDefaultSubclient": true,
        "isTrueUpOptionEnabled": false,
        "slaCategory": 4,
        "subClientPropertiesFlag": 0,
        "lastBackupSize": 0,
        "associatedSnapShotSCId": {
          "_type_": 7
        },
        "snapCopyInfo": {
          "useDB2ACSInterface": false,
          "useProxyForSQLIntegrity": {},
          "sybaseUser": {},
          "snapToTapeSelectedEngine": {
            "_type_": 110
          },
          "sqlUser": {},
          "vmApplicationUser": {},
          "snapToTapeProxyToUse": {
            "_type_": 3
          },
          "quiesceImpersonateUser": {},
          "separateProxyForSnapToTape": {
            "_type_": 3
          },
          "sshKey": {},
          "configuredSybaseInstance": {
            "_type_": 5
          }
        },
        "subclientPolicy": {
          "_type_": 65
        },
        "impersonateUserCredentialinfo": {
          "credentialId": 0,
          "credentialName": ""
        },
        "enableBackupAtDateTime": {
          "TimeZoneID": 0,
          "time": 0
        },
        "turboNASClient": {
          "_type_": 3
        },
        "prepostProcess": {
          "prepostUserName": {}
        },
        "storageDevice": {
          "dataBackupStoragePolicy": {
            "_type_": 17
          },
          "logBackupStoragePolicy": {
            "_type_": 17
          },
          "performanceMode": {
            "pipelineBufferSize": 64,
            "numOfPipelineBuffers": 180,
            "muxFactor": 0,
            "lookAheadReaderSlots": 4
          }
        },
        "UNCScriptCredentialinfo": {
          "credentialId": 0
        },
        "vmBackupValidationSettings": {
          "backupValidationThreadCount": 0,
          "uncScriptImpersonateUser": {}
        },
        "prepostCredentialinfo": {
          "credentialId": 0,
          "credentialName": ""
        },
        "associatedPolicy": {
          "subclientPolicyId": 0
        },
        "guestCredentialinfo": {
          "credentialId": 0
        }
      },
      "analyticsSubclientProp": {}
    },
    {
      "status": 0,
      "useLocalContent": true,
      "useLocalArchivalRules": false,
      "hcSubclientProp": {},
      "planEntity": {
        "planType": 2,
        "planName": "Server Plan",
        "planSubtype": 33554437,
        "planId": 1
      },
      "cassandraProps": {},
      "splunkProps": {},
      "proxyClient": {},
      "dcPlanEntity": {},
      "subClientEntity": {
        "clientName": "jnanlivesync1",
        "instanceName": "DefaultInstanceName",
        "displayName": "jnanlivesync1",
        "backupsetId": 8,
        "_type_": 7,
        "commCellName": "mustardtiger",
        "instanceId": 1,
        "csGUID": "53CF8EBC-16F4-40A8-A8CB-CBC4F2ABC536",
        "subclientGUID": "1C1B62B9-8BDD-4CB7-B836-F7C7F9F0AF6C",
        "subclientId": 47,
        "clientId": 7,
        "appName": "File System",
        "backupsetName": "defaultBackupSet",
        "applicationId": 33,
        "subclientName": "testtest",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        }
      },
      "dfsSubclientProp": {},
      "fsSubClientProp": {},
      "region": {},
      "commonProperties": {
        "slaStatus": 3,
        "disableArchivingTurboRule": false,
        "firstBackupTime": 0,
        "lastBackupTime": 0,
        "indexingBackupSubClient": false,
        "jobStartTime": -1,
        "isActivityDisabledFromPolicy": false,
        "enableBackupAfterDelay": false,
        "runAs": 0,
        "slaCategoryDescription": "Recently Installed with No Finished Job",
        "enableBackup": true,
        "idaType": 0,
        "runTrueUpJobAfterDays": 0,
        "isTrueUpOptionEnabled": false,
        "slaCategory": 10,
        "description": "",
        "subClientPropertiesFlag": 0,
        "lastBackupSize": 0,
        "associatedSnapShotSCId": {
          "_type_": 7
        },
        "snapCopyInfo": {
          "useDB2ACSInterface": false,
          "useProxyForSQLIntegrity": {},
          "sybaseUser": {},
          "snapToTapeSelectedEngine": {
            "_type_": 110
          },
          "sqlUser": {},
          "vmApplicationUser": {},
          "snapToTapeProxyToUse": {
            "_type_": 3
          },
          "quiesceImpersonateUser": {},
          "separateProxyForSnapToTape": {
            "_type_": 3
          },
          "sshKey": {},
          "configuredSybaseInstance": {
            "_type_": 5
          }
        },
        "subclientPolicy": {
          "_type_": 65
        },
        "impersonateUserCredentialinfo": {
          "credentialId": 0,
          "credentialName": ""
        },
        "enableBackupAtDateTime": {
          "TimeZoneID": 0,
          "time": 0
        },
        "turboNASClient": {
          "_type_": 3
        },
        "prepostProcess": {
          "prepostUserName": {}
        },
        "storageDevice": {
          "dataBackupStoragePolicy": {
            "_type_": 17,
            "storagePolicyName": "Server Plan",
            "storagePolicyId": 7
          },
          "logBackupStoragePolicy": {
            "_type_": 17
          },
          "performanceMode": {
            "pipelineBufferSize": 64,
            "numOfPipelineBuffers": 180,
            "muxFactor": 0,
            "lookAheadReaderSlots": 4
          }
        },
        "UNCScriptCredentialinfo": {
          "credentialId": 0
        },
        "vmBackupValidationSettings": {
          "backupValidationThreadCount": 0,
          "uncScriptImpersonateUser": {}
        },
        "prepostCredentialinfo": {
          "credentialId": 0,
          "credentialName": ""
        },
        "associatedPolicy": {
          "subclientPolicyId": 0
        },
        "guestCredentialinfo": {
          "credentialId": 0
        }
      },
      "analyticsSubclientProp": {}
    }
  ]
}

Get Subclient​

Get Subclient