> Software > Developer Tools > REST API > REST API Reference > Restore Operations

REST API - GET Client Hierarchy

This operation returns subclients that have backup jobs available to restore and the hierarchy above those subclients.

Request

Syntax

GET webservice/Client/clientID/Hierarchy?backedUp=value HTTP/1.1
Host: host name
Accept: application/xml | application/json
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

backedUp

The option to return subclients that do not have backup jobs available to restore.

Valid value is False.

No

Request Headers

Name

Description

Host

The host name of the Web Server or the Command Center 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

subclientId

The system-generated ID assigned to the subclient.

entity

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

entity

clientName

The name of the client.

entity

backupsetId

The system-generated ID assigned to the backup set.

entity

instanceId

The system-generated ID assigned to the instance.

entity

clientId

The system-generated ID assigned to the client.

entity

subclientName

The name of the subclient.

entity

backupsetName

The name of the backup set.

entity

instanceName

The name of the instance, for example: DefaultInstanceName.

entity

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

  • Windows File System

entity

Examples

Sample Request

This request returns subclients that have backup jobs available to restore.

GET webservice/Client/5/Hierarchy HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request returns subclients that do not have backup jobs available to restore.

GET webservice/Client/5/Hierarchy?backedUp=false HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<App_GetEntityHierarchyResponse> <entity subclientId="6" applicationId="33" clientName="clinet001" backupsetId="7" instanceId="1" clientId="5" subclientName="default" backupsetName="backup001" instanceName="DefaultInstanceName" appName="Windows File System"/>
</App_GetEntityHierarchyResponse>
×

Loading...