REST API - list

REST API - list

com.vmware.content.library.item.updatesession.file

The file service provides operations for accessing files within an update session.

After an update session is created against a library item, the file service can be used to make changes to the underlying library item metadata as well as the content of the files. The following changes can be made:

  • deleting an existing file within the library item. This deletes both the metadata and the content.
  • updating an existing file with new content.
  • adding a new file to the library item.

The above changes are not applied or visible until the session is completed. See com.vmware.content.library.item.update_session.

list

GET /com/vmware/content/library/item/updatesession/file
POST /com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=list
POST /com/vmware/content/library/item/updatesession/file?~action=list

Lists all files in the library item associated with the update session.
Request:
Representations:
{
    "update_session_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/content/library/item/updatesession/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <update_session_id>obj-103</update_session_id>
</ns0:List-Input>
GET /com/vmware/content/library/item/updatesession/file
?update_session_id=obj-103

Parameters:
Name Type Required Description
update_session_id
 *
 ID Yes Identifier of the update session. Id of type com.vmware.content.library.item.UpdateSession.

Response:
Representations:
{
    "value": [
        {
            "bytes_transferred": 10,
            "checksum_info": {
                "algorithm": "SH_a1",
                "checksum": "string"
            },
            "error_message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "name": "string",
            "size": 10,
            "source_endpoint": {
                "ssl_certificate_thumbprint": "string",
                "uri": "http://myurl.com"
            },
            "source_type": "NONE",
            "status": "WAITING_FOR_TRANSFER",
            "upload_endpoint": {
                "ssl_certificate_thumbprint": "string",
                "uri": "http://myurl.com"
            }
        },
        {
            "bytes_transferred": 10,
            "checksum_info": {
                "algorithm": "SH_a1",
                "checksum": "string"
            },
            "error_message": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "name": "string",
            "size": 10,
            "source_endpoint": {
                "ssl_certificate_thumbprint": "string",
                "uri": "http://myurl.com"
            },
            "source_type": "NONE",
            "status": "WAITING_FOR_TRANSFER",
            "upload_endpoint": {
                "ssl_certificate_thumbprint": "string",
                "uri": "http://myurl.com"
            }
        }
    ]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/content/library/item/updatesession/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <source_endpoint>
        <ssl_certificate_thumbprint>string</ssl_certificate_thumbprint>
        <uri>http://myurl.com</uri>
      </source_endpoint>
      <status>WAITING_FOR_TRANSFER</status>
      <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>
      <name>string</name>
      <upload_endpoint>
        <ssl_certificate_thumbprint>string</ssl_certificate_thumbprint>
        <uri>http://myurl.com</uri>
      </upload_endpoint>
      <source_type>NONE</source_type>
      <bytes_transferred>10</bytes_transferred>
      <checksum_info>
        <checksum>string</checksum>
        <algorithm>SH_a1</algorithm>
      </checksum_info>
      <size>10</size>
    </array-item>
    <array-item>
      <source_endpoint>
        <ssl_certificate_thumbprint>string</ssl_certificate_thumbprint>
        <uri>http://myurl.com</uri>
      </source_endpoint>
      <status>WAITING_FOR_TRANSFER</status>
      <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>
      <name>string</name>
      <upload_endpoint>
        <ssl_certificate_thumbprint>string</ssl_certificate_thumbprint>
        <uri>http://myurl.com</uri>
      </upload_endpoint>
      <source_type>NONE</source_type>
      <bytes_transferred>10</bytes_transferred>
      <checksum_info>
        <checksum>string</checksum>
        <algorithm>SH_a1</algorithm>
      </checksum_info>
      <size>10</size>
    </array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<info> Yes The array of the files in the library item associated with the update session. This array may be empty if the caller has removed all the files as part of this session (in which case completing the update session will result in an empty library item).

Errors:
Type Description HTTP Status Code
not_found if the update session doesn't exist. 404

Copyright © 2014. All Rights Reserved.