REST API - delete

REST API - delete

com.vmware.content.library.item

The item service provides operations for managing library items.

delete

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

Deletes a library item.

This operation will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing.

This operation cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.

Request:
Representations:
{
    "library_item_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Delete-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:Delete-Input>
POST /com/vmware/content/library/item?~action=delete
&library_item_id=obj-103

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

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
invalid_element_type if the library item with the given library_item_id is a member of a subscribed library. 400
not_found if the library item with the specified library_item_id does not exist. 404

Copyright © 2014. All Rights Reserved.