V11 SP8

REST API - POST Export Media


This operation exports media from tape libraries.



POST <webservice>/LibraryOperations HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/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.


Download the export_media_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 for the library. Use the  GET Library API to retrieve the ID. TMMsg_LibraryOperationRequest  
libraryOperationType The operation type for the request.

24 for exporting media.

mediaId The system generated ID assigned for the media. Use the POST Media and Location Details for Export API to retrieve the ID. mediaDetails exportOptions
name The name of the export location. Use the POST Media and Location Details for Export API to retrieve the name of the location or specify a new name which will be automatically added to the existing locations. exportLocations exportOptions


Response Parameters

Parameter Description Element
  • 0, successful completion.
  • 1, failure.
  • CVGui_GenericResp
    errorMessage The description of the error code. Not all error codes have an error message. CVGui_GenericResp


    Sample Request

    A library with 2 drives:

    POST <webservice>/LibraryOperations HTTP/1.1
    Host: client.mydomain.com
    Accept: application/xml
    Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
    Content-type: application/xml

    <?xml version="1.0" encoding="utf-8"?><TMMsg_LibraryOperationRequest LibraryId="334" libraryOperationType="24"><exportOptions><mediaDetails mediaId="506"/><exportLocations name="Shelf1"/></exportOptions></TMMsg_LibraryOperationRequest>

    Sample Response

    <?xml version="1.0" encoding="UTF-8" standalone="no" ?><EVGui_GenericResp errorCode="0" errorMessage=""/>