Update Item Update Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Updates the properties of an update session. This is an incremental update to the update session. Any field in the UpdateSessionModel structure that is unset will not be modified.
This operation will only update the property UpdateSessionModel.warning-behavior of the update session. This will not, for example, update the UpdateSessionModel.library-item-id or UpdateSessionModel.state of an update session.
This operation requires the session to be in the ACTIVE state.
if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the update session to retrieve. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. |
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 LibraryItemUpdateSessionUpdateRequestBody
of type application/json
(required)
{
"update_spec": {
"client_progress": 0,
"expiration_time": "string",
"id": "string",
"library_item_content_version": "string",
"library_item_id": "string",
"preview_info": {
"certificate_info": {
"issuer": "string",
"self_signed": false,
"subject": "string",
"x509": "string"
},
"state": "enum",
"warnings": [
{
"ignored": false,
"type": "enum"
}
]
},
"state": "enum",
"warning_behavior": [
{
"ignored": false,
"type": "enum"
}
]
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | update_spec | LibraryItemUpdateSessionModel |
Specification for the new property values to be set on the update session. |
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"update_spec":{"client_progress":0,"expiration_time":"string","id":"string","library_item_content_version":"string","library_item_id":"string","preview_info":{"certificate_info":{"issuer":"string","self_signed":false,"subject":"string","x509":"string"},"state":"enum","warnings":[{"ignored":false,"type":"enum"}]},"state":"enum","warning_behavior":[{"ignored":false,"type":"enum"}]}}' https://{api_host}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the update session does not exist. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the update session specification is not valid. |
