Update Item Update Session Deprecated
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
string
update_session_id
Required
Identifer of the update session that should be updated. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
LibraryItemUpdateSessionUpdateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"update_spec": {
"client_progress": 0,
"error_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"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": "UNAVAILABLE",
"warnings": [
{
"ignored": false,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"type": "SELF_SIGNED_CERTIFICATE"
}
]
},
"state": "ACTIVE",
"warning_behavior": [
{
"ignored": false,
"type": "SELF_SIGNED_CERTIFICATE"
}
]
}
}
update_spec
Required
Specification for the new property values to be set on the update session.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the update session is not in the ACTIVE state. | com.vmware.vapi.std.errors.invalid_argument : if the update session specification is not valid.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
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":"UNAVAILABLE","warnings":[{"ignored":false,"type":"SELF_SIGNED_CERTIFICATE"}]},"state":"ACTIVE","warning_behavior":[{"ignored":false,"type":"SELF_SIGNED_CERTIFICATE"}]}}' https://{api_host}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: patch
x-vmw-doc-new-path: /api/content/library/item/update-session/{update_session_id}
x-vmw-doc-operation: update
Availability
Added in 6.8.0
