REST API - download_session

content library item: download session model

The download_session_model structure provides information on an active content.library.item.download_session resource.

Representation:

JSON

{
    "client_progress": 1,
    "error_message": {
        "args": [
            "string",
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "expiration_time": "2015-01-01T22:13:05.651Z",
    "id": "obj-103",
    "library_item_content_version": "string",
    "library_item_id": "obj-103",
    "state": "ACTIVE"
}

Attributes:

Name	Type	Description
Optional
id	string	The identifier of this download session. Optional. This field is not used for the `create` operation. It will not be present in the result of the `get` or `list` operations. It is not used for the `update` operation.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.content.library.item.DownloadSession`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.content.library.item.DownloadSession`.
library_item_id	string	The identifier of the library item whose content is being downloaded. Optional. This field must be provided for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is not used for the `update` operation.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.content.library.Item`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.content.library.Item`.
library_item_content_version	string	The content version of the library item whose content is being downloaded. This value is the content.library.item_model.content_version at the time when the session is created for the library item. Optional. This field is not used for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is not used for the `update` operation.
error_message	localizable_message	If the session is in the ERROR status this property will have more details about the error. Optional. This field is not used for the `create` operation. It is optional in the result of the `get` or `list` operations. It is not used for the `update` operation.
client_progress	long	The progress that has been made with the download. This property is to be updated by the client during the download process to indicate the progress of its work in completing the download. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the download is complete. Optional. This field is not used for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is optional for the `update` operation.
state	string	The current state (`ACTIVE`, `CANCELED`, `ERROR`) of the download session. The state of the download session. Value is one of: ACTIVE: The session is active. Individual files may be in the process of being transferred and may become ready for download at different times. CANCELED: The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service. ERROR: Indicates there was an error during the session lifecycle.Optional. This field is not used for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is not used for the `update` operation.
expiration_time	date_time	Indicates the time after which the session will expire. The session is guaranteed not to expire before this time. Optional. This field is not used for the `create` operation. It will always be present in the result of the `get` or `list` operations. It is not used for the `update` operation.