REST API - delete

REST API - delete

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.

delete

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

Deletes a download session. This removes the session and all information associated with it.

Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item.

Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.

Request:
Representations:
{
    "download_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Delete-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:Delete-Input>
POST /com/vmware/content/library/item/download-session?~action=delete
&download_session_id=obj-103

Parameters:
Name Type Required Description
download_session_id
 *
 ID Yes Identifier of the download session to be deleted. 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 the download session does not exist. 404

Copyright © 2014. All Rights Reserved.