> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Restore Operations

REST API - POST Retrieve to Client (Restore)

Updated

This operation restores data obtained through a backup.

Note: To restore data with options not available in the POST retrieveToClient API, from the Restore Options dialog box, use Save as Script to generate an XML file. Use the TMMsg_CreateTaskReq XML with the POST QCommand API to restore your data.

Request

Syntax

Send the request using either XML or JSON:

  • XML

     
    POST <webservice>/retrieveToClient HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml
 <retrievetoclient_template.xml>

  • JSON

     
    POST <webservice>/retrieveToClient HTTP/1.1
 Host: <host name>
 Accept: application/json
 Authtoken: <authentication token>
 Content-type: application/json
 <retrievetoclient_template.json>

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 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.

Content-type

The media type contained in the request body.

Request Body

Download the XML or JSON file required for this request: retrievetoclient_template.xml or retrievetoclient_template.json. The following table displays the parameters for the request body.

Parameter

Description

Element

mode

Valid value is 2.

DM2ContentIndexing_RetrieveToClientReq

serviceType

Valid value is 1.

DM2ContentIndexing_RetrieveToClientReq

userGuid

The globally unique identifier for the user.

userInfo

clientId

The system-generated ID assigned to the client.

You can obtain the clientId from REST API - GET Client.

srcContent

appTypeId

The application type ID for the agent type associated with the file.

Valid values are:

Database/DB2

  • 37, DB2

  • 103, DB2 MultiNode

  • 62, DB2 on Unix

    Database/Exchange DB

  • 53, Exchange Database

    Database/Informix

  • 3, Informix Database

    Database/MySQL

  • 104, MySQL

    Database/Oracle

  • 22, Oracle Database

  • 80, Oracle RAC

    Database/Sybase

  • 5, Sybase Database

    Exchange Mail/Archived Mail

  • 56, Exchange Mailbox Archiver

  • 82, Exchange PF Archiver

Exchange Mail/Journaled Mail

  • 67, Exchange Compliance Archiver

    Exchange Mail/Protected Mail

  • 54, Exchange Mailbox

  • 35, Exchange Public Folder

    Files/Archived Files

  • 73, File Share Archiver

  • 66, Unix File Archiver

  • 58, Windows File Archiver

    Files/Protected Files

  • 41, Active Directory

  • 21, AIX File System

  • 91, DPM

  • 74, FreeBSD

  • 17, HP-UX Files System

  • 29, Linux File System

  • 63, Macintosh File System

  • 13, NAS

  • 124, Object Link

  • 131, Object Store

  • 86, OES File System on Linux

  • 130, Other External Agent

  • 64, CGI FileSystem

  • 20, Solaris 64bit File System

  • 19, Solaris File System

  • 36, Unix Tru64 64-bit File System

  • 106, Virtual Server

  • 33, Window File System

    SharePoint/Protected Documents

  • 78, SharePoint Server

srcContent

instanceId

The system-generated ID assigned to the instance.

You can obtain the instanceId from REST API - GET Instance.

srcContent

backupSetId

The system-generated ID assigned to the backup set.

You can get the backupSetId from REST API - GET Backup Set.

srcContent

subclientId

The system-generated ID assigned to the subclient.

You can get the subclientId from REST API - GET Subclient.

srcContent

fromTime

The option to restore using time. This parameter can be used with the toTime parameter or by itself:

  • Restore files backed up between two dates: <srcContent toTime="1378439999" fromTime="1378180800"/>.

  • Restore files backed up after a certain date: <srcContent fromTime="1378180800"/>.

    To find the timestamp for a specific version of a file, use the POST Browse API to send a request with the opType attribute in the <databrowse_BrowseRequest> element set to 2. In the POST Browse response, use the value in the backupTime attribute in the <advancedData> element as the value for fromTime.

    Valid values are UNIX-style timestamps (seconds since January 1, 1970).

srcContent

toTime

The option to restore using time. This parameter can be used with the fromTime parameter or by itself:

  • Restore files backed up between two dates: <srcContent toTime="1378439999" fromTime="1378180800"/>.

  • Restore files backed up before a certain date: <srcContent toTime="1378439999"/>.

    To find the timestamp for a specific version of a file, use the POST Browse API to send a request with the opType attribute in the <databrowse_BrowseRequest> element set to 2. In the POST Browse response, use the value in the backupTime attribute in the <advancedData> element as the value for toTime.

    Valid values are UNIX-style timestamps (seconds since January 1, 1970).

srcContent

clientId

The system-generated ID assigned to the client.

You can obtain the clientId from REST API - GET Client.

destination

clientName

The name of the client.

destination

inPlace

The option to restore data to its original location or to restore data to a new location.

Valid values are:

  • 0, to restore to a new location

  • 1, to restore to the original location

destination

val

Use for out-of-place restores. The data is restored to this destination path. If the new path does not exist on the client, the restore operation creates it.

destPath

val

The path to the file or folder to restore. To define more than one path, open the .xml file and add the <filePaths> element for each file or folder to restore, for example:

<filePaths val="\c:\SampleBackup\test\data2\rc"/>
<filePaths val="\c:\SampleBackup\test\data2\bottom_left.png"/>

filePaths

unconditionalOverwrite

The option to overwrite data with the version of the data on the media even if the data on the media is older, as old, or newer than the corresponding data on the destination machine.

Valid values are 0/1.

advanced

restoreDataAndACL

Valid values are 0/1.

advanced

restoreDeletedFiles

The option to restore deleted files.

Valid values are 0/1.

advanced

Response

Response Parameters

Parameter

Description

Element

jobId

The system-generated ID assigned to the job.

DM2ContentIndexing_RetrieveToClientResp

Examples

Sample Request

POST <webservice>/retrieveToClient HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <?xml version="1.0" encoding="UTF-8"?>
 <DM2ContentIndexing_RetrieveToClientReq mode="2" serviceType="1">
 <userInfo userGuid="8DDB1E31-53B0-46B0-AE2D-A5TEST5916DE"/>
 <header>
 <srcContent clientId="2" appTypeId="33" instanceId="1" backupSetId="31" subclientId="41"/>
 <destination clientId="2" clientName="devsrv" inPlace="1"/>
 <filePaths val="\C:\Sample Backup\testdata\data2\rc"/>
 <filePaths val="\C:\Sample Backup\testdata\data2\bottom_left.png"/>
 </header>
 <advanced restoreDataAndACL="1" restoreDeletedFiles="1"/>
 </DM2ContentIndexing_RetrieveToClientReq>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <DM2ContentIndexing_RetrieveToClientResp jobId="28075" />