REST API - cancel

REST API - cancel

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.

cancel

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

Cancels the update session and deletes it. This operation will free up any temporary resources currently associated with the session.

This operation is not allowed if the session has been already completed.

Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.

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

Parameters:
Name Type Required Description
update_session_id
 *
 ID Yes Identifier of the update session that should be canceled. 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_found if no update session with the given identifier exists. 404
not_allowed_in_current_state if the update session is not in the ACTIVE state. 400

Copyright © 2014. All Rights Reserved.