REST API - delete

REST API - delete

com.vmware.content.local_library

The LocalLibaray service manages local libraries.

The local_library service provides support for creating and maintaining local library instances. A local library may also use the com.vmware.content.library service to manage general library functionality.

delete

DELETE /com/vmware/content/local-library/id:{library_id}
POST /com/vmware/content/local-library/id:{library_id}?~action=delete
POST /com/vmware/content/local-library?~action=delete

Deletes the specified local library.

Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Request:
Representations:
{
    "library_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Delete-Input xmlns:ns0="http://vmware.com/content/local_library" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <library_id>obj-103</library_id>
</ns0:Delete-Input>
POST /com/vmware/content/local-library?~action=delete
&library_id=obj-103

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

Response:
Representations:

Parameters:
Name Type Required Description
result VOID Yes

Errors:
Type Description HTTP Status Code
invalid_element_type if the library specified by library_id is not a local library. 400
not_found if the library specified by library_id does not exist. 404

Copyright © 2014. All Rights Reserved.