REST API - list

REST API - list

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.

list

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

Lists the information of all the files in the library item associated with the download session.
Request:
Representations:
{
    "download_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-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>
</ns0:List-Input>
GET /com/vmware/content/library/item/downloadsession/file
?download_session_id=obj-103

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

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"
        },
        {
            "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:List-Result xmlns:ns0="http://vmware.com/content/library/item/downloadsession/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <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>
    </array-item>
    <array-item>
      <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>
    </array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<info> Yes The array of com.vmware.content.library.item.downloadsession.file.info instances.

Errors:
Type Description HTTP Status Code
not_found if the download session associated with download_session_id doesn't exist. 404

Copyright © 2014. All Rights Reserved.