REST API - get

REST API - get

com.vmware.content.library.item.downloadsession.file

The file service provides operations for accessing files within a download session.

After a download session is created against a library item, the file service can be used to retrieve all downloadable content within the library item. Since the content may not be available immediately in a downloadable form on the server side, the client will have to prepare the file and wait for the file status to become PREPARED.

See com.vmware.content.library.item.download_session.

get

POST /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get
POST /com/vmware/content/library/item/downloadsession/file?~action=get

Retrieves file download information for a specific file.
Request:
Representations:
{
    "download_session_id": "obj-103",
    "file_name": "string"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/content/library/item/downloadsession/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <download_session_id>obj-103</download_session_id>
  <file_name>string</file_name>
</ns0:Get-Input>
POST /com/vmware/content/library/item/downloadsession/file?~action=get
&download_session_id=obj-103
&file_name=string

Parameters:
Name Type Required Description
download_session_id
 *
 ID Yes Identifier of the download session. Id of type com.vmware.content.library.item.DownloadSession.
file_name
 *
 string Yes Name of the file requested.

Response:
Representations:
{
    "value": {
        "bytes_transferred": 10,
        "checksum_info": {
            "algorithm": "SH_a1",
            "checksum": "string"
        },
        "download_endpoint": {
            "ssl_certificate_thumbprint": "string",
            "uri": "http://myurl.com"
        },
        "error_message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "name": "string",
        "size": 10,
        "status": "UNPREPARED"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library/item/downloadsession/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <download_endpoint>
      <ssl_certificate_thumbprint>string</ssl_certificate_thumbprint>
      <uri>http://myurl.com</uri>
    </download_endpoint>
    <status>UNPREPARED</status>
    <error_message>
      <default_message>string</default_message>
      <id>string</id>
      <args-array>
        <array-item>string</array-item>
        <array-item>string</array-item>
      </args-array>
    </error_message>
    <name>string</name>
    <bytes_transferred>10</bytes_transferred>
    <checksum_info>
      <checksum>string</checksum>
      <algorithm>SH_a1</algorithm>
    </checksum_info>
    <size>10</size>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result info Yes The com.vmware.content.library.item.downloadsession.file.info instance containing the status of the file and its download link if available.

Errors:
Type Description HTTP Status Code
not_found if the download session associated with download_session_id does not exist. 404
invalid_argument if there is no file with the specified file_name. 400

Copyright © 2014. All Rights Reserved.