REST API - get

REST API - get

com.vmware.content.library.item

The item service provides operations for managing library items.

get

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

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

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

Response:
Representations:
{
    "value": {
        "cached": true,
        "content_version": "string",
        "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",
        "library_id": "obj-103",
        "metadata_version": "string",
        "name": "string",
        "size": 10,
        "source_id": "obj-103",
        "type": "string",
        "version": "string"
    }
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/content/library/item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <cached>true</cached>
    <library_id>obj-103</library_id>
    <source_id>obj-103</source_id>
    <metadata_version>string</metadata_version>
    <type>string</type>
    <last_sync_time>2013-06-06T22:13:05</last_sync_time>
    <version>string</version>
    <size>10</size>
    <id>obj-103</id>
    <content_version>string</content_version>
    <description>string</description>
    <last_modified_time>2013-06-06T22:13:05</last_modified_time>
    <name>string</name>
    <creation_time>2013-06-06T22:13:05</creation_time>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result item_model Yes The com.vmware.content.library.item_model instance with the given library_item_id.

Errors:
Type Description HTTP Status Code
not_found if no item with the given library_item_id exists. 404

Copyright © 2014. All Rights Reserved.