POST /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail |
POST /com/vmware/content/library/item/download-session?~action=fail |
This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
{
"client_error_message": "string", "download_session_id": "obj-103" }
<?xml version="1.0" ?>
<ns0:Fail-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> <client_error_message>string</client_error_message> </ns0:Fail-Input>
POST /com/vmware/content/library/item/download-session?~action=fail
&download_session_id=obj-103 &client_error_message=string |
Name | Type | Required | Description |
---|---|---|---|
download_session_id* |
ID | Yes | Identifier of the download session to fail. Id of type com.vmware.content.library.item.DownloadSession. |
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. |
Name | Type | Required | Description |
---|---|---|---|
result | VOID | Yes |
Type | Description | HTTP Status Code |
---|---|---|
not_found | if the download session does not exist. | 404 |
not_allowed_in_current_state | if the download session is not in the ACTIVE state. | 400 |
Copyright © 2014. All Rights Reserved.