REST API - get

REST API - get

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.

get

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

Retrieves the information for a single file in a library item by its name.
Request:
Representations:
{
    "library_item_id": "obj-103",
    "name": "string"
}
<?xml version="1.0" ?>
<ns0:Get-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>
  <name>string</name>
</ns0:Get-Input>
POST /com/vmware/content/library/item/file?~action=get
&library_item_id=obj-103
&name=string

Parameters:
Name Type Required Description
library_item_id
 *
 ID Yes Identifier of the library item whose file information should be returned. Id of type com.vmware.content.library.Item.
name
 *
 string Yes Name of the file in the library item whose information should be returned.

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

Parameters:
Name Type Required Description
result info Yes The com.vmware.content.library.item.file.info object with information on the specified file.

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.