REST API - create

REST API - create

com.vmware.content.library.item.download_session

The download_session 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 com.vmware.content.library.item.downloadsession.file service provides access to the download links.

create

POST /com/vmware/content/library/item/download-session
POST /com/vmware/content/library/item/download-session?~action=create

Creates a new download session.
Request:
Representations:
{
    "client_token": "string",
    "create_spec": {
        "client_progress": 10,
        "error_message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "expiration_time": "2013-06-06T22:13:05",
        "id": "obj-103",
        "library_item_content_version": "string",
        "library_item_id": "obj-103",
        "state": "ACTIVE"
    }
}
<?xml version="1.0" ?>
<ns0:Create-Input xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <create_spec>
    <id>obj-103</id>
    <library_item_id>obj-103</library_item_id>
    <client_progress>10</client_progress>
    <error_message>
      <default_message>string</default_message>
      <id>string</id>
      <args-array>
        <array-item>string</array-item>
        <array-item>string</array-item>
      </args-array>
    </error_message>
    <state>ACTIVE</state>
    <expiration_time>2013-06-06T22:13:05</expiration_time>
    <library_item_content_version>string</library_item_content_version>
  </create_spec>
  <client_token>string</client_token>
</ns0:Create-Input>
POST /com/vmware/content/library/item/download-session
?create_spec.id=obj-103
&create_spec.library_item_id=obj-103
&create_spec.client_progress=10
&create_spec.error_message.default_message=string
&create_spec.error_message.id=string
&create_spec.error_message.args.1=string
&create_spec.error_message.args.2=string
&create_spec.state=ACTIVE
&create_spec.expiration_time=2013-06-06T22%3A13%3A05
&create_spec.library_item_content_version=string
&client_token=string

Parameters:
Name Type Required Description
client_token string No 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.
create_spec
 *
 download_session_model Yes Specification for the new download session to be created.

Response:
Representations:
{
    "value": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Create-Result xmlns:ns0="http://vmware.com/content/library/item/download_session" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>obj-103</value>
</ns0:Create-Result>

Parameters:
Name Type Required Description
result ID Yes Identifier of the new download session being created. Id of type com.vmware.content.library.item.DownloadSession.

Errors:
Type Description HTTP Status Code
invalid_argument if the session specification is not valid. 400
not_found if the library item targeted by the download does not exist. 404

Copyright © 2014. All Rights Reserved.