Create Item Download Session
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Creates a new download session. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the attribute DownloadSessionModel.library-item-id requires ContentLibrary.DownloadSession.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/download-session
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
LibraryItemDownloadSessionCreateRequestBody of type application/json (required){
"create_spec": {}
}
create_spec
Required
Specification for the new download session to be created.
string
client_token
Optional
A unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemDownloadSessionCreateResponseBody
of type application/json
Identifier of the new download session being created. The result will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
{
"value": "string"
}
string
value
Optional
Identifier of the new download session being created. The result will be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_token":"string","create_spec":{"client_progress":0,"expiration_time":"string","id":"string","library_item_content_version":"string","library_item_id":"string","state":"enum"}}' https://{api_host}/rest/com/vmware/content/library/item/download-session
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the session specification is not valid.
format.
404
com.vmware.vapi.std.errors.not_found : if the library item targeted by the download does not exist.
