REST API - POST Clone Subclient
The operation creates a clone of an existing subclient.
Request
Syntax
POST <webservice>/Subclient/{subclientId}/Clone HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml
<clone_subclient_template.xml>
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 |
subclientId |
The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. |
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. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type |
The media type contained in the request body. |
Request Body
Download the clone_subclient_template.xml file required for this request. The following table displays the parameters for the clone_subclient_template.xml file.
Parameter |
Description |
Parent Element |
subclientName |
The name of the subclient to clone. |
cloneEntity |
backupsetName |
The name of the backup where the cloned subclient is located. |
cloneEntity |
instanceName |
The name of the instance where the cloned subclient is located. |
cloneEntity |
appName |
The type of application or agent where the cloned subclient is located. |
cloneEntity |
clientName |
The name of the client where the cloned subclient is located. |
cloneEntity |
subclientName |
The name of the new subclient to create. |
subClientProperties/subClientEntity |
path |
A path to add to the content of the new subclient. |
subClientProperties/content |
Response
Response Parameters
Parameter |
Description |
Element |
subclientId |
The new ID of the subclient created from the request. |
response |
Examples
Example Request
POST <webservice>/Subclient/123/Clone HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_CloneSubClientRequest>
<cloneEntity>
<subclientName>test1</subclientName>
<backupsetName>defaultBackupSet</backupsetName>
<instanceName>DefaultInstanceName</instanceName>
<appName>File System</appName>
<clientName>client1</clientName>
</cloneEntity>
<subClientProperties>
<subClientEntity>
<subclientName>NewSubClient2</subclientName>
</subClientEntity>
<content>
<path>C:\Windows</path>
</content>
</subClientProperties>
</App_CloneSubClientRequest>
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_CloneSubClientResponse>
<processinginstructioninfo>
<attributes name="exitval" value="0"/>
</processinginstructioninfo>
<response errorCode="0" warningCode="0" warningMessage="">
<entity _type_="0" subclientId="109"/>
</response>
</App_CloneSubClientResponse>
Last modified: 5/30/2019 4:27:59 PM