REST API - get

REST API - get

com.vmware.content.library.item.download_session

The download_session service manipulates download sessions, which are used to download content from the Content Library Service.

A download session is an object that tracks the download of content (that is, downloading content from the Content Library Service) and acts as a lease to keep the download links available.

The com.vmware.content.library.item.downloadsession.file service provides access to the download links.

get

GET /com/vmware/content/library/item/download-session/id:{download_session_id}
POST /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=get
POST /com/vmware/content/library/item/download-session?~action=get

Gets the download session with the specified identifier, including the most up-to-date status information for the session.
Request:
Representations:
{
    "download_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <download_session_id>obj-103</download_session_id>
</ns0:Get-Input>
POST /com/vmware/content/library/item/download-session?~action=get
&download_session_id=obj-103

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

Response:
Representations:
{
    "value": {
        "client_progress": 10,
        "error_message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "expiration_time": "2013-06-06T22:13:05",
        "id": "obj-103",
        "library_item_content_version": "string",
        "library_item_id": "obj-103",
        "state": "ACTIVE"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <id>obj-103</id>
    <library_item_id>obj-103</library_item_id>
    <client_progress>10</client_progress>
    <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>
    <state>ACTIVE</state>
    <expiration_time>2013-06-06T22:13:05</expiration_time>
    <library_item_content_version>string</library_item_content_version>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result download_session_model Yes The com.vmware.content.library.item.download_session_model instance with the given download_session_id.

Errors:
Type Description HTTP Status Code
not_found if no download session with the given download_session_id exists. 404

Copyright © 2014. All Rights Reserved.