Developer Documentation
Fail Item Update Session
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.
if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the update session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. |
Request Body
Request Body
Contains
FailRequestBody
of type application/json
(required)
{
"client_error_message": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| 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. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the update session does not exist. |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state. |
| default | Error | Not available |
