Update Item
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/id:{library_item_id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains LibraryItemUpdateRequestBody
of type application/json
(required)
{
"update_spec": {
"cached": false,
"content_version": "string",
"creation_time": "string",
"description": "string",
"id": "string",
"last_modified_time": "string",
"last_sync_time": "string",
"library_id": "string",
"metadata_version": "string",
"name": "string",
"size": 0,
"source_id": "string",
"type": "string",
"version": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | update_spec | LibraryItemModel |
Specification of the properties to set. |
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"update_spec":{"cached":false,"content_version":"string","creation_time":"string","description":"string","id":"string","last_modified_time":"string","last_sync_time":"string","library_id":"string","metadata_version":"string","name":"string","size":0,"source_id":"string","type":"string","version":"string"}}' https://{api_host}/rest/com/vmware/content/library/item/id:{library_item_id}
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_element_type : if the library item corresponding to libraryItemId is a member of a subscribed library. | com.vmware.vapi.std.errors.invalid_argument : if one of the following is true for the updateSpec: - name is empty - name exceeds 80 characters - description exceeds 2000 characters - version is not equal to the current version of the library item |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the library item specified by libraryItemId does not exist. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the library item belongs to a published library with JSON persistence enabled (see PublishInfo.persist-json-enabled) and the content of the library item specified by libraryItemId has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it. | com.vmware.vapi.std.errors.already_exists : if there is already a library item with same name in the library. |
On This Page
Item Operations
get
post
get
patch
delete
post
post
post
