Content Library Item DownloadSession 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.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires System.Anonymous.

Request

URI

POST

https://{api_host}/api/content/library/item/download-session/{downloadSessionId}?action=fail

COPY

Path Parameters

string

downloadSessionId

Required

Identifier of the download session to fail.

The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

Request Body

Request body for invoking operation: fail

{
    "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.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

if the download session is not in the Content Library Item DownloadSessionModel State.ACTIVE state.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

404

if the download session does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"client_error_message:"string"}' https://{api_host}/api/content/library/item/download-session/{downloadSessionId}?action=fail

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Content Operations

GET

Content Library Item DownloadSession list