REST API - get

REST API - get

com.vmware.content.library.item.storage

storage is a resource that represents a specific instance of a file stored on a storage backing. Unlike com.vmware.content.library.item.file, which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in com.vmware.content.library.item.file, but will be represented multiple times (once for each storage backing) in storage. The storage service provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.

get

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

Retrieves the storage information for a specific file in a library item.
Request:
Representations:
{
    "file_name": "string",
    "library_item_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/content/library/item/storage" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_item_id>obj-103</library_item_id>
  <file_name>string</file_name>
</ns0:Get-Input>
POST /com/vmware/content/library/item/storage?~action=get
&library_item_id=obj-103
&file_name=string

Parameters:
Name Type Required Description
library_item_id
 *
 ID Yes Identifier of the library item whose storage information should be retrieved. Id of type com.vmware.content.library.Item.
file_name
 *
 string Yes Name of the file for which the storage information should be listed.

Response:
Representations:
{
    "value": [
        {
            "storage_backing": {
                "datastore_id": "obj-103",
                "storage_uri": "http://myurl.com",
                "type": "DATASTORE"
            },
            "storage_uris": [
                "http://myurl.com",
                "http://myurl.com"
            ]
        },
        {
            "storage_backing": {
                "datastore_id": "obj-103",
                "storage_uri": "http://myurl.com",
                "type": "DATASTORE"
            },
            "storage_uris": [
                "http://myurl.com",
                "http://myurl.com"
            ]
        }
    ]
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library/item/storage" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <storage_backing>
        <datastore_id>obj-103</datastore_id>
        <storage_uri>http://myurl.com</storage_uri>
        <type>DATASTORE</type>
      </storage_backing>
      <storage_uris-array>
        <array-item>http://myurl.com</array-item>
        <array-item>http://myurl.com</array-item>
      </storage_uris-array>
    </array-item>
    <array-item>
      <storage_backing>
        <datastore_id>obj-103</datastore_id>
        <storage_uri>http://myurl.com</storage_uri>
        <type>DATASTORE</type>
      </storage_backing>
      <storage_uris-array>
        <array-item>http://myurl.com</array-item>
        <array-item>http://myurl.com</array-item>
      </storage_uris-array>
    </array-item>
  </value-array>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result List<info> Yes The array of all the storage items for the given file within the given library item.

Errors:
Type Description HTTP Status Code
not_found if the specified library item does not exist. 404

Copyright © 2014. All Rights Reserved.