com.vmware.content.library

The library service provides operations to manage and find com.vmware.content.library_model entities.

The library service provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this service will not affect the properties specific to the type of library. See also com.vmware.content.local_library and com.vmware.content.subscribed_library.

get

GET /com/vmware/content/library/id:{library_id}
POST /com/vmware/content/library/id:{library_id}?~action=get
POST /com/vmware/content/library?~action=get

Returns a given com.vmware.content.library_model.
Request:
Representations:
{
    "library_id""obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/content/library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_id>obj-103</library_id>
</ns0:Get-Input>
POST /com/vmware/content/library?~action=get
&library_id=obj-103

Parameters:
Name Type Required Description
library_id
 *
ID Yes Identifier of the library to return. Id of type com.vmware.content.Library.

Response:
Representations:
{
    "value"{
        "creation_time""2013-06-06T22:13:05",
        "description""string",
        "id""obj-103",
        "last_modified_time""2013-06-06T22:13:05",
        "last_sync_time""2013-06-06T22:13:05",
        "name""string",
        "publish_info"{
            "authentication_method""BASIC",
            "password""secret string",
            "persist_json_enabled"true,
            "publish_url""http://myurl.com",
            "published"true,
            "user_name""string"
        },
        "server_guid""obj-103",
        "storage_backings"[
            {
                "datastore_id""obj-103",
                "storage_uri""http://myurl.com",
                "type""DATASTORE"
            },
            {
                "datastore_id""obj-103",
                "storage_uri""http://myurl.com",
                "type""DATASTORE"
            }
        ],
        "subscription_info"{
            "authentication_method""BASIC",
            "automatic_sync_enabled"true,
            "on_demand"true,
            "password""secret string",
            "ssl_thumbprint""string",
            "subscription_url""http://myurl.com",
            "user_name""string"
        },
        "type""LOCAL",
        "version""string"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <id>obj-103</id>
    <publish_info>
      <user_name>string</user_name>
      <publish_url>http://myurl.com</publish_url>
      <authentication_method>BASIC</authentication_method>
      <published>true</published>
      <persist_json_enabled>true</persist_json_enabled>
      <password>secret string</password>
    </publish_info>
    <storage_backings-array>
      <array-item>
        <datastore_id>obj-103</datastore_id>
        <storage_uri>http://myurl.com</storage_uri>
        <type>DATASTORE</type>
      </array-item>
      <array-item>
        <datastore_id>obj-103</datastore_id>
        <storage_uri>http://myurl.com</storage_uri>
        <type>DATASTORE</type>
      </array-item>
    </storage_backings-array>
    <last_modified_time>2013-06-06T22:13:05</last_modified_time>
    <description>string</description>
    <name>string</name>
    <creation_time>2013-06-06T22:13:05</creation_time>
    <subscription_info>
      <user_name>string</user_name>
      <ssl_thumbprint>string</ssl_thumbprint>
      <on_demand>true</on_demand>
      <automatic_sync_enabled>true</automatic_sync_enabled>
      <subscription_url>http://myurl.com</subscription_url>
      <authentication_method>BASIC</authentication_method>
      <password>secret string</password>
    </subscription_info>
    <type>LOCAL</type>
    <server_guid>obj-103</server_guid>
    <last_sync_time>2013-06-06T22:13:05</last_sync_time>
    <version>string</version>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result library_model Yes The com.vmware.content.library_model instance with the specified library_id.

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

Copyright © 2014. All Rights Reserved.