This API has a deprecated equivalent from v7.0U1.
Fail Item Download Session
Terminates the download session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to download 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}/api/content/library/item/download-session/{download_session_id}?action=fail
Path Parameters
Path Parameters
string
download_session_id
Required
Identifier of the download session to fail. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
LibraryItemDownloadSessionFailRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the download session is not in the ACTIVE state.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LibraryItemDownloadSessionFailRequestBody = Initialize-LibraryItemDownloadSessionFailRequestBody -ClientErrorMessage "MyClientErrorMessage"
Invoke-FailDownloadSessionId -DownloadSessionId "MyDownloadSessionId" -LibraryItemDownloadSessionFailRequestBody $LibraryItemDownloadSessionFailRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_error_message":"string"}' https://{api_host}/api/content/library/item/download-session/{download_session_id}?action=fail
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail
x-vmw-doc-operation: fail
Availability
Added in 7.0U2
