content library item download session: 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:
HTTP request
POST https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| download_session_id | string | Identifier of the download session whose lifetime should be extended. |
Request Body Structure:
{
"progress": 1
}
"progress": 1
}
<?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>1</progress>
</ns0:KeepAlive-Input>
<ns0:KeepAlive-Input xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<progress>1</progress>
</ns0:KeepAlive-Input>
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| progress | long | Optional. Optional update to the progress property of the session. If specified, the new progress should be greater then the current progress. See content.library.item.download_session_model.client_progress. |
Response:
HTTP Status Code: 200
NoneErrors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if no download session with the given identifier exists. |
| 400 | not_allowed_in_current_state | if the download session is not in the ACTIVE state. |