Loading...

REST API - POST Browse

This operation browses data obtained through a backup.

Request

Syntax

Send the request using either XML or JSON:

  • XML

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

    <browse_template.xml>

  • JSON

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

    <browse_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: browse_template.xml or browse_template.json. The following table displays the parameters for the request body.

Parameter

Description and Parameter Values

Element

Parent Element

opType

The operation type of the browse request.

Valid values are:

  • browse, to browse files one level at a time.
  • find, to search for files recursively.
  • versions, to show all versions of a file.
  • dodeletefromindex, to delete all versions of a file.

databrowse_BrowseRequest

 

sessionId

The unique browse session ID returned in a browse request. Use the session ID to improve the response time of subsequent browse requests if you are changing paths, changing paging, or sorting parameters. Do not use the browse session ID when other parameters change: time range, show deleted items flag, search parameters, or mode.

session

databrowse_BrowseRequest

clientName

The name of the client.

entity

databrowse_BrowseRequest

applicationId

The ID of the application.

Valid values are:

 

  • 53, for Exchange Database
  • 33, for File System
  • 75, for Image Level on Unix
  • 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

databrowse_BrowseRequest

clientId

The system-generated ID assigned to the client.

entity

databrowse_BrowseRequest

subclientId

The system-generated ID assigned to the subclient.

entity

databrowse_BrowseRequest

backupsetId

The system-generated ID assigned to the backup set.

entity

databrowse_BrowseRequest

instanceId

The system-generated ID assigned to the instance.

entity

databrowse_BrowseRequest

path

The path to browse. To browse at the root level, use a backslash (\). For example, <paths path="\"/>.

paths

databrowse_BrowseRequest

toTime

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

  • Browse files backed up between two date: <timeRange toTime="1378439999" fromTime="1378180800"/>.
  • Browse files backed up before a certain date: <timeRange toTime="1378439999"/>.

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

timeRange

databrowse_BrowseRequest

fromTime

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

  • Browse files backed up between two date: <timeRange toTime="1378439999" fromTime="1378180800"/>.
  • Browse files backed up after a certain date: <timeRange fromTime="1378180800"/>.

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

timeRange

databrowse_BrowseRequest

showDeletedFiles

The option to include deleted files.

Valid values are 0/1.

options

databrowse_BrowseRequest

restoreIndex

The option to automatically restore the index if it is not cached.

Valid values are 0/1.

options

databrowse_BrowseRequest

mode

The mode of the browse request.

Valid value is 2.

mode

databrowse_BrowseRequest

type

The type of query. This parameter must be used with the queryID parameter in the <queries> element.

Valid values are:

  • 0, for a data query.

    <queries type="0" queryId="dataQuery">

  • 1, for an aggregate query.

    <queries type="1" queryId="countQuery">

queries

databrowse_BrowseRequest

queryId

The unique identifier of the query. This parameter must be used with the type parameter in the <queries> element.

Valid values are:

  • dataQuery, for a data query.

    <queries type="0" queryId="dataQuery">

  • countQuery, for an aggregate query.

    <queries type="1" queryId="countQuery">

queries

databrowse_BrowseRequest

aggrType

The option that controls the aggregate query. For browse operations, this parameter counts the number of results returned. This parameter must be used with the field parameter in the <aggrParam> element.

Valid value is 4.

<queries type="1" queryId="countQuery">
<aggrParam aggrType="4" field="0"/>
</queries>

aggrParam

queries

field

The option that specifies what the aggrType parameter counts. For browse operations, this parameter is the file name. This parameter must be used with the aggrType parameter in the <aggrParam> element.

Valid value is 0.

<queries type="1" queryId="countQuery">
<aggrParam aggrType="4" field="0"/>
</queries>

aggrParam

queries

firstNode

This option must be used when a data query is included in the request, for example queryId="dataQuery".

Valid value is 0.

<queries type="0" queryId="dataQuery">
<dataParam>
<paging firstNode="0" skipNode="0" pageSize="15"/>
</dataParam>
</queries>

paging

dataParam

skipNode

The index number of the first item returned. Use this attribute with the pageSize attribute to control what returns in the browse results. For example, if the browse path "C:\Documents" contains 55 files, the 55 files are indexed starting with zero. Setting skipNode to "20" and pageSize to "10" will return index items 20 through 29.

paging

dataParam

pageSize

The number of items returned. Use this attribute with the skipNode attribute to control what returns in the browse results. For example, if the browse path "C:\Documents" contains 55 files, the 55 files are indexed starting with zero. Setting skipNode to "20" and pageSize to "10" will return index items 20 through 29.

paging

dataParam

ascending

This option specifies the direction of the sort used on the results of the data query. The data to sort by is defined in the val parameter of the <sortBy> element.

Valid values are 0/1.

<queries type="0" queryId="dataQuery">
<dataParam>
<paging firstNode="0"/>
<sortParam ascending="0">
<sortBy val="38"/>
<sortBy val="0"/>
</sortParam>
</dataParam>
</queries>

sortParam

dataParam

val

This option specifies the data to sort by. The direction of the sort is defined in the ascending parameter of the <sortParam> element.

Valid values are:

  • 0, to sort by the file name.
  • 1, to sort by the <modificationTime> element.
  • 2, to sort by the size parameter in the <dataResultSet> element.
  • 38, to sort by the <flags> element.

    Multiple val parameters are allowed. For example:

    <sortBy val="38"/>
    <sortBy val="0"/>

sortBy

sortParam

Response

Response Parameters

Parameter

Description

Element

respType

The response type of the browse request.

Valid value is 0.

browseResponses

workerId

An internal reference number.

browseResponses

queryId

The unique identifier of the query.

Valid values are:

  • dataQuery, for a data query.
  • countQuery, for an aggregate query.

browseResult

displayName

The name of the item.

dataResultSet

displayPath

The location of the item.

dataResultSet

modificationTime

The date and time the item was last modified.

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

dataResultSet

name

The name of the item.

dataResultSet

path

The location of the item.

dataResultSet

size

The size of the item.

dataResultSet

archiveFileId

The system-generated ID assigned to the archived item.

advancedData

archiveGroupId

The system-generated ID assigned to the archived group where the item is backed up.

advancedData

backupJobId

The system-generated ID assigned to the job that backed up the item.

advancedData

backupTime

The date and time the item was backed up.

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

advancedData

cipId

An internal reference number.

advancedData

imageMap

The image map of the item.

advancedData

offset

 

advancedData

referenceTime

The date and time the item was backed up.

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

advancedData

guid

The globally unique identifier for the stub.

dmStubData

folderSize

The size of the folder.

indexing

securityInfo

 

securityData

aTime

 

fsDAta

cTime

 

fsDAta

groupName

 

fsDAta

userName

 

fsDAta

_type_

The CommCell objects associated with the browse.

Valid value is 1.

sourceCommServer

commCellId

The CommCell ID of the CommServe.

Valid value is 2.

sourceCommServer

type

 

sourceCommServer

_type_

The CommCell objects associated with the browse.

Valid value is 7.

subclient

applicationId

The ID of the application.

Valid values are:

 

  • 53, for Exchange Database
  • 33, for File System
  • 75, for Image Level on Unix
  • 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

 

subclient

directory

 

flags

sessionId

The unique browse session ID returned in a browse request. Use the session ID to improve the response time of subsequent browse requests if you are changing paths, changing paging, or sorting parameters. Do not use the browse session ID when other parameters change: time range, show deleted items flag, search parameters, or mode.

session

result

The number of browse results.

aggrResultSet

Examples

Sample Request

POST <webservice>/DoBrowse HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<databrowse_BrowseRequest opType="browse">
  <entity clientName="client001" applicationId="33" clientId="2" subclientId="2" backupsetId="3" instanceId="1"/>
  <paths path="C:\users"/>
  <options showDeletedFiles="1" restoreIndex="1"/>
  <mode mode="2"/>
  <queries type="1" queryId="countQuery">
    <aggrParam aggrType="4" field="0"/>
  </queries>
  <queries type="0" queryId="dataQuery">
    <dataParam>
      <paging firstNode="0" skipNode="0" pageSize="15"/>
      <sortParam ascending="1">
        <sortBy val="38"/>
        <sortBy val="0"/>
      </sortParam>
    </dataParam>
  </queries>
</databrowse_BrowseRequest>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<databrowse_BrowseResponseList>
  <browseResponses respType="0" workerId="87">
    <browseResult queryId="dataQuery">
      <dataResultSet displayName="admin" displayPath="\C:\Users\admin" modificationTime="1383155548" name="|21|#12!admin" path="\C:\Users\admin" size="1008">
        <advancedData archiveFileId="853" archiveGroupId="6" backupJobId="1151" backupTime="1385164640" cipId="0" imageMap="1151 IN " offset="27236" referenceTime="1385164640">
          <browseMetaData>
            <dmStubData guid="cvlt_8506089da446740b915fe7802ddcbf67" />
            <indexing folderSize="1008" />
            <securityData securityInfo="A&lt;S-1-5-18|1f01ff&gt;A&lt;S-1-5-32-544|1f01ff&gt;A&lt;S-1-5-21-3393418607-3554941549-4209072599-1105|1f01ff&gt;" />
          </browseMetaData>
          <sourceCommServer _type_="1" commCellId="2" type="0" />
          <subclient _type_="7" applicationId="2" />
        </advancedData>
        <flags directory="1" />
      </dataResultSet>
      <dataResultSet displayName="Administrator" displayPath="\C:\Users\Administrator" modificationTime="1377895252" name="|4|#12!Administrator" path="\C:\Users\Administrator" size="121659">
        <advancedData archiveFileId="853" archiveGroupId="6" backupJobId="1151" backupTime="1385164640" cipId="0" imageMap="1151 IN " offset="0" referenceTime="1385164640">
          <browseMetaData>
            <dmStubData guid="cvlt_605a1ecd61cadc0d834ee7c055a744cd" />
            <indexing folderSize="121659" />
            <securityData securityInfo="A&lt;S-1-5-18|1f01ff&gt;A&lt;S-1-5-32-544|1f01ff&gt;A&lt;S-1-5-21-555860399-384967793-3212812041-500|1f01ff&gt;" />
          </browseMetaData>
          <sourceCommServer _type_="1" commCellId="2" type="0" />
          <subclient _type_="7" applicationId="2" />
        </advancedData>
        <flags directory="1" />
      </dataResultSet>
    </browseResult>
    <session sessionId="1385584418-87" />
  </browseResponses>
  <browseResponses respType="0" workerId="87">
    <browseResult queryId="countQuery">
      <aggrResultSet result="2" />
    </browseResult>
    <session sessionId="1385584418-87" />
  </browseResponses>
</databrowse_BrowseResponseList>\

Last modified: 1/9/2019 8:34:47 PM