REST API - keep_alive

REST API - keep_alive

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.

keep_alive

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

Keeps a download session alive. This operation is allowed only if the session is in the ACTIVE state.

If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of an active download session.

Request:
Representations:
{
    "download_session_id": "obj-103",
    "progress": 10
}
<?xml version="1.0" ?>
<ns0:KeepAlive-Input xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <progress>10</progress>
  <download_session_id>obj-103</download_session_id>
</ns0:KeepAlive-Input>
POST /com/vmware/content/library/item/download-session?~action=keep-alive
&progress=10
&download_session_id=obj-103

Parameters:
Name Type Required Description
download_session_id
 *
 ID Yes Identifier of the download session whose lifetime should be extended. Id of type com.vmware.content.library.item.DownloadSession.
progress long No Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See com.vmware.content.library.item.download_session_model.client_progress.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
not_found if no download session with the given identifier exists. 404
not_allowed_in_current_state if the download session is not in the ACTIVE state. 400

Copyright © 2014. All Rights Reserved.