REST API - prepare
  1. Operations
  2. content
  3. library
  4. item
  5. downloadsession
  6. file

content library item downloadsession file: prepare

Requests a file to be prepared for download.

Request:

HTTP request

POST https://{server}/rest/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare

Path Parameters

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

Request Body Structure:

{
    "endpoint_type" : "HTTPS",
    "file_name" : "string"
}

Request Body Parameters:

Name Type Description
bold = required
file_name string Name of the file requested for download.
endpoint_type string Optional. Endpoint type request, one of HTTPS, DIRECT. This will determine the type of the content.library.item.downloadsession.file.info.download_endpoint that is generated when the file is prepared. The DIRECT is only available to users who have the ContentLibrary.ReadStorage privilege.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "bytes_transferred" : 1,
        "error_message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        },
        "size" : 1,
        "checksum_info" : {
            "checksum" : "string",
            "algorithm" : "SHA1"
        },
        "name" : "string",
        "download_endpoint" : {
            "ssl_certificate_thumbprint" : "string",
            "uri" : "http://myurl.com"
        },
        "status" : "UNPREPARED"
    }
}

Response Type:

Name Type Description
bold = required
value info File information containing the status of the request and the download link to the file.
value.name string The name of the file.
value.size long The file size, in bytes.

Optional. This field may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.
value.bytes_transferred long The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.
value.status string The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING, PREPARED, ERROR) of the file.

Defines the state of the file in preparation for download. Value is one of:
UNPREPARED: The file hasn't been requested for preparation.
PREPARE_REQUESTED: A prepare has been requested, however the server hasn't started the preparation yet.
PREPARING: A prepare has been requested and the file is in the process of being prepared.
PREPARED: Prepare succeeded. The file is ready for download.
ERROR: Prepare failed.
value.download_endpoint transfer_endpoint Endpoint at which the file is available for download. The value is valid only when the content.library.item.downloadsession.file.info.status is PREPARED.

Optional. This field won't be set until the file status is PREPARED.
value.download_endpoint.uri URI Transfer endpoint URI. The supported URI schemes are: http, https, and ds.

An endpoint URI with the ds scheme specifies the location of the file on the datastore. The format of the datastore URI is:

  • ds:///vmfs/volumes/uuid/path

When the transfer endpoint is a datastore location, the server can import the file directly from the storage backing without the overhead of streaming over HTTP.
value.download_endpoint.ssl_certificate_thumbprint string Thumbprint of the expected SSL certificate for this endpoint. Only used for HTTPS connections. The thumbprint is the SHA-1 hash of the DER encoding of the remote endpoint's SSL certificate. If set, the remote endpoint's SSL certificate is only accepted if it matches this thumbprint, and no other certificate validation is performed.

Optional. If not specified, standard certificate validation is performed.
value.checksum_info checksum_info The checksum information of the file. When the download is complete, you can retrieve the checksum from the get operation to verify the checksum for the downloaded file.

Optional. The checksum is always calculated for the downloaded file, but this field won't be set until the download is complete.
value.checksum_info.algorithm string The checksum algorithm (SHA1, MD5, SHA256, SHA512) used to calculate the checksum.

Optional. If not specified the default checksum algorithm is SH_a1.
value.checksum_info.checksum string The checksum value calculated with content.library.item.file.checksum_info.algorithm.
value.error_message localizable_message Error message for a failed preparation when the prepare status is ERROR.

Optional. This field won't be set unless there was an error with the file transfer.
value.error_message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error_message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error_message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
value.error_message.params list Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
value.error_message.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.

Errors:

HTTP Status Code Type Description
404 not_found if the download session does not exist.
400 invalid_argument if there is no file with the specified file_name.
403 unauthorized if the the download session wasn't created with the ContentLibrary.ReadStorage privilege and the caller requested a DIRECT endpoint type.