content library item update session: 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:
HTTP request
POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| update_session_id | string | Identifier of the update session to fail. |
Request Body Structure:
{
"client_error_message": "string"
}
"client_error_message": "string"
}
<?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>
</ns0:Fail-Input>
<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>
</ns0:Fail-Input>
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| client_error_message | string | 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:
HTTP Status Code: 200
NoneErrors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the update session does not exist. |
| 400 | not_allowed_in_current_state | if the update session is not in the ACTIVE state. |