REST API - delete

REST API - delete

com.vmware.content.library.item.update_session

The update_session service manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item.

An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific com.vmware.content.library.item_model, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

The management of the files within the session is done through the com.vmware.content.library.item.updatesession.file service.

delete

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

Deletes an update session. This removes the session and all information associated with it.

Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item.

Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.

Request:
Representations:
{
    "update_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Delete-Input xmlns:ns0="http://vmware.com/content/library/item/update_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <update_session_id>obj-103</update_session_id>
</ns0:Delete-Input>
POST /com/vmware/content/library/item/update-session?~action=delete
&update_session_id=obj-103

Parameters:
Name Type Required Description
update_session_id
 *
 ID Yes Identifer of the update session to delete. Id of type com.vmware.content.library.item.UpdateSession.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
not_allowed_in_current_state if the update session is in the ACTIVE state. 400

Copyright © 2014. All Rights Reserved.