REST API - fail
  1. Operations
  2. content
  3. library
  4. item
  5. download session

content library item download session: fail

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.

Request:

HTTP request

POST https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail

Path Parameters

Name Type Description
Required
download_session_id string Identifier of the download session to fail.

Request Body Structure:

{
    "client_error_message" : "string"
}

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

None

Errors:

HTTP Status Code Type Description
404 not_found if the download session does not exist.
400 not_allowed_in_current_state if the download session is not in the ACTIVE state.