Library Item Download Session APIs
The DownloadSession service manipulates download sessions, which are used to download content from the Content Library Service. A download session is an object that tracks the download of content (that is, downloading content from the Content Library Service) and acts as a lease to keep the download links available.
The File service provides access to the download links.
Operations
POST
Cancel Download Session Id
Cancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Create Library Item Download Session
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.
GET
List Library 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.
DELETE
Delete Download Session Id Item
Deletes a download session. This removes the session and all information associated with it. Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
GET
Get Download Session Id Item
Gets the download session with the specified identifier, including the most up-to-date status information for the session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Fail Download Session Id
Terminates the download session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to download a file) to the server side. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Keep Alive Download Session Id
Keeps a download session alive. This operation is allowed only if the session is in the ACTIVE state. If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of an active download session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.