UpdateSession APIs
The UpdateSession service manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item. An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific ItemModel, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.
Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
The management of the files within the session is done through the File service.
Operations
POST
Cancel Update Session Id
Cancels the update session and sets its state to CANCELED. This operation will free up any temporary resources currently associated with the session. This operation is not allowed if the session has been already completed. Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Complete Update Session Id
Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. This operation requires the session to be in the ACTIVE state. Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the File.validate operation. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Create Library 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.
GET
List Library Item Update Session
Lists the identifiers of the update session created by the calling user. Optionally may filter by library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.item.UpdateSession referenced by the parameter libraryItemId requires ContentLibrary.UpdateSession.
DELETE
Delete Update Session Id Item
Deletes an update session. This removes the session and all information associated with it. Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item. Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
GET
Get Update Session Id Item
Gets the update session with the specified identifier, including the most up-to-date status information for the session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
PATCH
Update Update Session Id Item
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.
POST
Fail Update Session Id
Terminates the update session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to access a file) to the server side. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
POST
Keep Alive Update Session Id
Keeps an update session alive. If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of the update session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.