REST API - fail

REST API - fail

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.

fail

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

Terminates the update session with a client specified error message.

This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.

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

Parameters:
Name Type Required Description
update_session_id
 *
 ID Yes Identifier of the update session to fail. Id of type com.vmware.content.library.item.UpdateSession.
client_error_message
 *
 string Yes Client side error message. This can be useful in providing some extra details about the client side failure. Note that the message won't be translated to the user's locale.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
not_found if the update session does not exist. 404
not_allowed_in_current_state if the update session is not in the ACTIVE state. 400

Copyright © 2014. All Rights Reserved.