REST API - cancel

REST API - cancel

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.

cancel

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

Cancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.
Request:
Representations:
{
    "download_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Cancel-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:Cancel-Input>
POST /com/vmware/content/library/item/download-session?~action=cancel
&download_session_id=obj-103

Parameters:
Name Type Required Description
download_session_id
 *
 ID Yes Identifer of the download session that should be canceled. Id of type com.vmware.content.library.item.DownloadSession.

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.