Create Item Update Session
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/content/library/item/update-session
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 LibraryItemUpdateSessionCreateRequestBody
of type application/json
(required)
{
"create_spec": {}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | create_spec | LibraryItemUpdateSessionModel |
Specification for the new update session to be created. |
| optional | client_token | string |
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. |
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemUpdateSessionCreateResponseBody
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.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Identifier of the new update session being created. The result will be an identifier for the resource type: com.vmware.content.library.item.UpdateSession. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_token":"string","create_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
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | 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. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the item targeted for update does not exist. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.resource_busy : if there is another update session on the same library item. |
| default | ErrorRest | Not available |
