Fail Item Update Session
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
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
Parameters
Parameters
string
update_session_id
Required
Identifier of the update session to fail.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
LibraryItemUpdateSessionFailRequestBody of type application/json (required){
"client_error_message": "string"
}
string
client_error_message
Required
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.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_error_message":"string"}' https://{api_host}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail
Errors
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state.
