Prepare Item Downloadsession File Deprecated
Requests a file to be prepared for download. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare
Path Parameters
Path Parameters
string
download_session_id
Required
Identifier of the download session. 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
LibraryItemDownloadsessionFilePrepareRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"file_name": "string"
}
string
file_name
Required
Name of the file requested for download.
endpoint_type
Optional
The File.EndpointType enumerated type defines the types of endpoints used to download the file.
HTTPS : An https download endpoint.
DIRECT : A direct download endpoint indicating the location of the file on storage. The caller is responsible for retrieving the file from the storage location directly.
Possible values are: HTTPS , DIRECT
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemDownloadsessionFilePrepareResponseBody of type application/json
File information containing the status of the request and the download link to the file.
{
"value": {
"bytes_transferred": 0,
"checksum_info": {
"algorithm": "SHA1",
"checksum": "string"
},
"download_endpoint": {
"ssl_certificate_thumbprint": "string",
"uri": "string"
},
"error_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"name": "string",
"size": 0,
"status": "UNPREPARED"
}
}
value
Optional
File information containing the status of the request and the download link to the file.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if there is no file with the specified fileName.
403
com.vmware.vapi.std.errors.unauthorized : if the the download session wasn’t created with the ContentLibrary.ReadStorage privilege and the caller requested a DIRECT endpoint type.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"endpoint_type":"HTTPS","file_name":"string"}' https://{api_host}/rest/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/content/library/item/download-session/{download_session_id}/file?action=prepare
x-vmw-doc-operation: prepare
