This API has a deprecated equivalent from v7.0U1.
Create Item Update Session
Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. Content Library Service allows only one single update session to be active for a specific library item.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the attribute UpdateSessionModel.library-item-id requires ContentLibrary.UpdateSession.
Request
URLURL
https://{api_host}/api/content/library/item/update-session
Header Parameters
Header Parameters
string
client_token
Optional
Unique token generated by the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent.
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
LibraryItemUpdateSessionModel of mimetype application/json
Required
Specification for the new update session to be created.
{
"client_progress": 0,
"error_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"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": {
"cert_chain": [
"string"
],
"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": {
"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"
}
]
}
integer
client_progress
Optional
The progress that has been made with the upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update is complete. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
error_message
Optional
If the session is in the ERROR status this property will have more details about the error. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.
string
expiration_time
Optional
Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than this time. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
string
id
Optional
The identifier of this update session. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
string
library_item_content_version
Optional
The content version of the library item whose content is being modified. This value is the ItemModel.content-version at the time when the session is created for the library item. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.
string
library_item_id
Optional
The identifier of the library item to which content will be uploaded or removed. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.
preview_info
Optional
A preview of the files currently being uploaded in the session. This property will be set only when the session is in the ACTIVE. This field is optional and it is only relevant when the value of UpdateSessionModel.state is ACTIVE.
state
Optional
The state of an update session.
ACTIVE : The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
DONE : The session is done and all its effects are now visible.
ERROR : There was an error during the session.
CANCELED : The session has been canceled.
Possible values are: ACTIVE , DONE , ERROR , CANCELED
warning_behavior
Optional
Indicates the update session behavior if warnings are raised in the session preview. Any warning which is raised by session preview but not ignored by the client will, by default, fail the update session. This field is optional for the create operation. It is optional in the result of the get or list operations. It is optional for the update operation.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string of type application/json
Identifier of the new update session being created. The result will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
Code Samples
PowerCLI Client SDK Example
$StdNestedLocalizableMessage = Initialize-StdNestedLocalizableMessage -Id "MyId" -Params @{ key_example = $StdLocalizationParam }
$StdLocalizationParam = Initialize-StdLocalizationParam -S "MyS" -Dt (Get-Date) -I 0 -D 0 -L $StdNestedLocalizableMessage -Format "SHORT_DATE" -Precision 0
$StdLocalizableMessage = Initialize-StdLocalizableMessage -Id "MyId" -DefaultMessage "MyDefaultMessage" -VarArgs "MyVarArgs" -Params @{ key_example = $StdLocalizationParam } -Localized "MyLocalized"
$LibraryItemUpdatesessionCertificateInfo = Initialize-LibraryItemUpdatesessionCertificateInfo -Issuer "MyIssuer" -Subject "MySubject" -SelfSigned $false -X509 "MyX509"
$LibraryItemUpdatesessionPreviewWarningInfo = Initialize-LibraryItemUpdatesessionPreviewWarningInfo -Type "SELF_SIGNED_CERTIFICATE" -Message $StdLocalizableMessage -Ignored $false
$LibraryItemUpdatesessionPreviewInfo = Initialize-LibraryItemUpdatesessionPreviewInfo -State "UNAVAILABLE" -CertificateInfo $LibraryItemUpdatesessionCertificateInfo -Warnings $LibraryItemUpdatesessionPreviewWarningInfo -CertChain "MyCertChain"
$LibraryItemUpdatesessionWarningBehavior = Initialize-LibraryItemUpdatesessionWarningBehavior -Type "SELF_SIGNED_CERTIFICATE" -Ignored $false
$LibraryItemUpdateSessionModel = Initialize-LibraryItemUpdateSessionModel -Id "MyId" -LibraryItemId "MyLibraryItemId" -LibraryItemContentVersion "MyLibraryItemContentVersion" -ErrorMessage $StdLocalizableMessage -ClientProgress 0 -State "ACTIVE" -ExpirationTime (Get-Date) -PreviewInfo $LibraryItemUpdatesessionPreviewInfo -WarningBehavior $LibraryItemUpdatesessionWarningBehavior
Invoke-CreateLibraryItemUpdateSession -LibraryItemUpdateSessionModel $LibraryItemUpdateSessionModel -ClientToken "MyClientToken"
cURL Command
curl -X POST -H "client_token: string" -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_progress":0,"expiration_time":"string","id":"string","library_item_content_version":"string","library_item_id":"string","preview_info":{"cert_chain":["string"],"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}/api/content/library/item/update-session
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the session specification is not valid. if the clientToken does not conform to the UUID format. | com.vmware.vapi.std.errors.invalid_element_type : if the update session is being created on a subscribed library item.
500
com.vmware.vapi.std.errors.resource_busy : if there is another update session on the same library item.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/item/update-session
x-vmw-doc-operation: create
Availability
Added in 7.0U2
