REST API - list

content library item downloadsession file: list

Lists the information of all the files in the library item associated with the download session.

Request:

HTTP request

GET https://{server}/rest/com/vmware/content/library/item/downloadsession/file

?download_session_id=obj-103

Request Query Parameters:

Name Type Description
bold = required
download_session_id string Identifier of the download session.

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"
        },
        {
            "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[] The array of content.library.item.downloadsession.file.info instances.
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.

Errors:

HTTP Status Code Type Description
404 not_found if the download session associated with download_session_id doesn't exist.