REST API - GET Subclient

This operation returns a list of subclients for a client.

Request

Syntax

Send the request using either the ID or the name:

GET <webservice>/Subclient?clientId={clientId} HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>

Name

GET <webservice>/Subclient?clientName={clientName} HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
clientId	The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.	Yes-for the request by ID
clientName	The client name for the client. If the client name is not known, use the GET Client API to retrieve it.	Yes-for the request by name

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

_type_

The CommCell objects associated with the subclient.

Valid value is SUBCLIENT_ENTITY.

subClientEntity

appName

The name of the application.

Valid values are:

Active Directory
DB2
DB2 MultiNode
DB2 on UNIX
Documentum
Exchange Database
File System
Informix Database
MySQL
NAS
Notes Database

Oracle
Oracle RAC
PostgreSQL
SAP HANA
SAP for MAX DB
SAP for Oracle
Sharepoint Server
SQL Server
Sybase Database
Virtual Server

subClientEntity

applicationId

The ID of the application.

Valid values are:

53, for Exchange Database
33, for File System
104, for MySQL
13, for NAS
59, for Notes Database
22, for Oracle

80, for Oracle RAC
125, for PostgreSQL
79, for SAP for MAX DB
61, for SAP for Oracle
81, for SQL Server
5, for Sybase Database
106, Virtual Server

subClientEntity

backupsetName

The name of the backup set.

subClientEntity

backupsetId

The system-generated ID assigned to the backup set.

subClientEntity

clientName

The name of the client.

subClientEntity

clientId

The system-generated ID assigned to the client.

subClientEntity

instanceName

The name of the instance, for example: DefaultInstanceName.

subClientEntity

instanceId

The system-generated ID assigned to the instance.

subClientEntity

subclientName

The name of the subclient.

subClientEntity

subclientId

The system-generated ID assigned to the subclient.

subClientEntity

Examples

Sample Request

This request uses the ID.

GET <webservice>/Subclient?clientId=2 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request uses the name.

GET <webservice>/Subclient?clientName=client001 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetSubClientPropertiesResponse>
   <subClientProperties>
     <subClientEntity _type_="SUBCLIENT_ENTITY" appName="File System" applicationId="33" backupsetId="3" backupsetName="defaultBackupSet" clientId="2" clientName="client001" instanceId="1" instanceName="DefaultInstanceName" subclientId="2" subclientName="default"/>
   </subClientProperties>
   <subClientProperties>
     <subClientEntity _type_="SUBCLIENT_ENTITY" appName="File System" applicationId="33" backupsetId="3" backupsetName="defaultBackupSet" clientId="2" clientName="client001" instanceId="1" instanceName="DefaultInstanceName" subclientId="2" subclientName="testsubclient"/>
   </subClientProperties>
 </App_GetSubClientPropertiesResponse>