Loading...

REST API - GET Recall

This operation initiates a download of data obtained through a backup.

Request

Syntax

GET <webservice>/Recall?at={appTypeId}&si={stubinfo}&op={path}&appId={subclientId}&ec={encoding} 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

at

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
  • 83, Netware File 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
  • 65, Image Level
  • 75, Image Level On Unix
  • 76, Image Level ProxyHost
  • 87, Image Level ProxyHost on Unix
  • 29, Linux File System
  • 63, Macintosh File System
  • 13, NAS
  • 12, Netware File System
  • 10, Novell Directory Services
  • 124, Object Link
  • 131, Object Store
  • 86, OES File System on Linux
  • 130, Other External Agent
  • 38, Proxy Client File System
  • 40, ProxyHost on Unix
  • 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
  • 107, Workstation Backup

    SharePoint/Protected Documents

  • 78, SharePoint Server

 

Yes

si

The stub information for the file.

  1. Construct this parameter from this information, in this order:
    • stubVersion: For file system downloads, this value is 2.
    • commcellNumber: Use the POST Browse API to retrieve this value.
    • groupNumber: For file system downloads, this value is 0.
    • archiveFileId: Use the POST Browse API to retrieve this value.
    • offset: Use the POST Browse API to retrieve this value.
  2. Separate the values with colons, for example: 2:721090:0:1:65452367
  3. Encode the entire string using Base64 encoding.

Yes

op

The file path. If the file path is not known, use the POST Browse API to retrieve it.

Encode the entire string using Base64 encoding.

Yes

appId

The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it.

Yes

ec

The type of encoding to use. This value is always 1.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

The response for the GET Recall API is a string.

Examples

Sample Request

GET <webservice>/Recall?at=33&si=Mjo3MjEwOTA6MDoxOjY1NDUyMzY3&op=XEM6XFNhbXBsZSBCYWNrdXBcRWRnZSBEYXRhIFByb3RlY3Rpb24ubXA0&appId=2&ec=1 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Last modified: 4/3/2018 6:03:22 PM