Loading...

REST API - POST Media and Location Details for Export

This operation gets media and location details for export.

Request

Syntax

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

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

XML

Download the get_media_location_details_template.xml file required for this request. The following table displays the parameters for the template file.

Name

Description

Element

Parent Element

LibraryId

The system generated ID assigned  the library. Use the  GET Library API to retrieve the ID.

TMMsg_LibraryOperationRequest

 

libraryOperationType

The operation type for the request.

23 to get media and location details for export.

TMMsg_LibraryOperationReques

 

Response

Response Parameters

Parameter

Description

Element

Location

The current location of the media.

exportOptions

attribute

Media attribute.

exportOptions

barCode

The bar code for the media.

exportOptions

extentedAttributes

Extended attribute.

exportOptions

lastWriteTime

The most recent time at which data was written on the media.

exportOptions

mediaId

System generated ID for the media.

exportOptions

retainDataUntil

Retain until date.

exportOptions

sizeOfStoredData

The total size on the media.

exportOptions

id

System generated ID for the media group to which the media belongs.

mediaGroup

name

Media Group name.

mediaGroup

id

System generated ID for the storage policy to which the media belongs.

StoragePolicy

name

Storage Policy name.

StoragePolicy

id

System generated ID for the storage policy copy to which the media belongs.

StoragePolicyCopy

name

Storage Policy Copy name.

StoragePolicyCopy

id

System generated ID for the export locations available for the media.

exportLocations

name

Export location name.

exportLocations

Examples

Sample Request

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

<TMMsg_LibraryOperationRequest LibraryId="334" libraryOperationType="23"/>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_LibraryOperationResponse>
 <exportOptions>
  <mediaDetails Location="slot 1" attribute="8388608" barCode="000000WW" extentedAttributes="0" lastWriteTime="1488352185" mediaId="456" retainDataUntil="0" sizeOfStoredData="0"> <mediaGroup id="197" name="Overwrite Protect Media"/>
  <StoragePolicy id="0" name=""/>
  <StoragePolicyCopy id="0" name=""/> </mediaDetails>
  <mediaDetails Location="slot 2" attribute="8388608" barCode="000001WW" extentedAttributes="0" lastWriteTime="1488489633" mediaId="457" retainDataUntil="1488207160" sizeOfStoredData="0"> <mediaGroup id="194" name="Default Scratch"/>
  <StoragePolicy id="0" name=""/>
  <StoragePolicyCopy id="0" name=""/>
  </mediaDetails>
  <exportLocations id="1" name="Shelf1"/>
  <exportLocations id="2" name="Shelf2"/>
 </exportOptions>
</TMMsg_LibraryOperationResponse>

Last modified: 1/10/2018 7:57:49 PM