This API has a deprecated equivalent from v7.0U1.

List Item Download Session

Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.item.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.

Request

URL

GET

https://{api_host}/api/content/library/item/download-session

Copy

Query Parameters

string

library_item_id Required

Library item identifier on which to filter results. If not specified all download session identifiers are listed. The parameter must be an identifier for the resource type: com.vmware.content.library.item.DownloadSession.

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"

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK returns array of string of type application/json

The list of identifiers of all download sessions created by the calling user. The result will contain identifiers for the resource type: com.vmware.content.library.item.DownloadSession.

Errors

Error

404

com.vmware.vapi.std.errors.not_found : if a library item identifier is given for an item which does not exist.

Error

default

‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.

Code Samples

PowerCLI Client SDK Example

Invoke-ListLibraryItemDownloadSession -LibraryItemId "MyLibraryItemId"

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/download-session?library_item_id=string

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/download-session
x-vmw-doc-operation: list