REST API - update

REST API - update

com.vmware.content.library.item

The item service provides operations for managing library items.

update

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

Updates the specified properties of a library item.

This is an incremental update to the library item. Fields that are unset in the update specification are left unchanged.

This operation cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

Request:
Representations:
{
    "library_item_id": "obj-103",
    "update_spec": {
        "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:Update-Input xmlns:ns0="http://vmware.com/content/library/item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <update_spec>
    <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>
  </update_spec>
  <library_item_id>obj-103</library_item_id>
</ns0:Update-Input>
POST /com/vmware/content/library/item?~action=update
&update_spec.cached=true
&update_spec.library_id=obj-103
&update_spec.source_id=obj-103
&update_spec.metadata_version=string
&update_spec.type=string
&update_spec.last_sync_time=2013-06-06T22%3A13%3A05
&update_spec.version=string
&update_spec.size=10
&update_spec.id=obj-103
&update_spec.content_version=string
&update_spec.description=string
&update_spec.last_modified_time=2013-06-06T22%3A13%3A05
&update_spec.name=string
&update_spec.creation_time=2013-06-06T22%3A13%3A05
&library_item_id=obj-103

Parameters:
Name Type Required Description
library_item_id
 *
 ID Yes Identifier of the library item to update. Id of type com.vmware.content.library.Item.
update_spec
 *
 item_model Yes Specification of the properties to set.

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
not_found if the library item specified by library_item_id does not exist. 404
invalid_element_type if the library item corresponding to library_item_id is a member of a subscribed library. 400
invalid_argument if one of the following is true for the update_spec:
  • name is empty
  • name exceeds 80 characters
  • description exceeds 1024 characters
  • version is not equal to the current version of the library item
 400

Copyright © 2014. All Rights Reserved.