REST API - list

REST API - list

com.vmware.content.library.item.file

The file service can be used to query for information on the files within a library item. Files are objects which are added to a library item through the com.vmware.content.library.item.update_session and com.vmware.content.library.item.updatesession.file services.

list

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

Lists all of the files that are stored within a given library item.
Request:
Representations:
{
    "library_item_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:List-Input xmlns:ns0="http://vmware.com/content/library/item/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_item_id>obj-103</library_item_id>
</ns0:List-Input>
GET /com/vmware/content/library/item/file
?library_item_id=obj-103

Parameters:
Name Type Required Description
library_item_id
 *
 ID Yes Identifier of the library item whose files should be listed. Id of type com.vmware.content.library.Item.

Response:
Representations:
{
    "value": [
        {
            "cached": true,
            "checksum_info": {
                "algorithm": "SH_a1",
                "checksum": "string"
            },
            "name": "string",
            "size": 10,
            "version": "string"
        },
        {
            "cached": true,
            "checksum_info": {
                "algorithm": "SH_a1",
                "checksum": "string"
            },
            "name": "string",
            "size": 10,
            "version": "string"
        }
    ]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/content/library/item/file" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <cached>true</cached>
      <name>string</name>
      <version>string</version>
      <size>10</size>
      <checksum_info>
        <checksum>string</checksum>
        <algorithm>SH_a1</algorithm>
      </checksum_info>
    </array-item>
    <array-item>
      <cached>true</cached>
      <name>string</name>
      <version>string</version>
      <size>10</size>
      <checksum_info>
        <checksum>string</checksum>
        <algorithm>SH_a1</algorithm>
      </checksum_info>
    </array-item>
  </value-array>
</ns0:List-Result>

Parameters:
Name Type Required Description
result List<info> Yes The array of all of the files that are stored within the given library item.

Errors:
Type Description HTTP Status Code
not_found if library_item_id refers to a library item that does not exist. 404

Copyright © 2014. All Rights Reserved.