Developer Documentation

REST API Operations Index

All available Content REST API Operations.


Content

Configuration
patch Update Configuration
Updates the configuration. The update is incremental. Any field in the ConfigurationModel structure that is unset will not be modified. Note that this update operation doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.UpdateConfiguration.
get Get Configuration
Retrieves the current configuration values. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.GetConfiguration.
Library
get List Library
Returns the identifiers of all libraries of any type in the Content Library. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
get Get Library
Returns a given LibraryModel. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.
patch Update Library
Updates the properties of a library. This is an incremental update to the library. Any field in the LibraryModel structure that is unset will not be modified. This operation will only update the common properties for all library types. This will not, for example, update the LibraryModel.publish-info of a local library, nor the LibraryModel.subscription-info of a subscribed library. Specific properties are updated in LocalLibrary.update and SubscribedLibrary.update. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLibrary.
post Find Library
Returns a list of all the visible (as determined by authorization policy) libraries matching the requested Library.FindSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Local Library
post Create Local Library
Creates a new local library. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.CreateLocalLibrary. - The resource Datastore referenced by the attribute StorageBacking.datastore-id requires Datastore.AllocateSpace.
get List Local Library
Returns the identifiers of all local libraries in the Content Library. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
delete Delete Local Library
Deletes the specified local library. Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteLocalLibrary.
get Get Local Library
Returns a given local library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.
patch Update Local Library
Updates the properties of a local library. This is an incremental update to the local library. Fields that are unset in the update specification will be left unchanged. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateLocalLibrary.
post Publish Local Library
Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary.
Subscribed Library
get List Subscribed Library
Returns the identifiers of all subscribed libraries in the Content Library. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
post Create Subscribed Library
Creates a new subscribed library. Once created, the subscribed library will be empty. If the LibraryModel.subscription-info property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.CreateSubscribedLibrary. - The resource Datastore referenced by the attribute StorageBacking.datastore-id requires Datastore.AllocateSpace.
delete Delete Subscribed Library
Deletes the specified subscribed library. Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.DeleteSubscribedLibrary.
get Get Subscribed Library
Returns a given subscribed library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.
patch Update Subscribed Library
Updates the properties of a subscribed library. This is an incremental update to the subscribed library. Fields that are unset in the update specification will be left unchanged. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateSubscribedLibrary.
post Evict Subscribed Library
Evicts the cached content of an on-demand subscribed library. This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.EvictSubscribedLibrary.
post Sync Subscribed Library
Forces the synchronization of the subscribed library. Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo.on-demand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.SyncLibrary.
post Probe Subscribed Library
Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibrary.ProbeResult structure describes whether or not the subscription configuration is successful. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.ProbeSubscription.
Type
get List Type
Returns a list of Type.Info instances which describe the type support plugins in this Content Library. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.TypeIntrospection.

Library

Item
get List Item
Returns the identifiers of all items in the given library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.
post Create Item
Creates a new library item. A new library item is created without any content. After creation, content can be added through the UpdateSession and File services. A library item cannot be created in a subscribed library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the attribute ItemModel.library-id requires ContentLibrary.AddLibraryItem.
delete Delete Item
Deletes a library item. This operation will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing. This operation cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.DeleteLibraryItem.
get Get Item
Returns the ItemModel with the given identifier. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.
patch Update Item
Updates the specified properties of a library item. This is an incremental update to the library item. Fields that are unset in the update specification are left unchanged. This operation cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.UpdateLibraryItem.
post Publish Item
Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.PublishLibraryItem.
post Copy Item
Copies a library item. Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. A library item cannot be copied into a subscribed library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter sourceLibraryItemId requires System.Read. - The resource com.vmware.content.Library referenced by the attribute ItemModel.library-id requires ContentLibrary.AddLibraryItem.
post Find Item
Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested Item.FindSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.Library referenced by the attribute Item.FindSpec.library-id requires System.Read.
Subscribed Item
post Evict Subscribed Item
Evicts the cached content of a library item in a subscribed library. This operation allows the cached content of a library item to be removed to free up storage capacity. This operation will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel.cached to false. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.EvictLibraryItem.
post Sync Subscribed Item
Forces the synchronization of an individual library item in a subscribed library. Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this operation will delete the library item from the subscribed library as well. The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item. - If SubscriptionInfo.on-demand is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter. - If SubscriptionInfo.on-demand is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand. When the file content has been synchronized, the ItemModel.cached field will be true. This operation will return immediately and create an asynchronous task to perform the synchronization. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.SyncLibraryItem.
Subscriptions
get List Subscriptions
Lists the subscriptions of the published library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires System.Read.
post Create Subscriptions
Creates a subscription of the published library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription.
patch Update Subscriptions
Updates the specified subscription of the published library. This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement structure, fields that are unset in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all fields of the current subscribed library placement will be replaced by this placement. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.
delete Delete Subscriptions
Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription.
get Get Subscriptions
Returns information about the specified subscription of the published library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires System.Read.
Item Changes
get List Item Changes
Returns commonly used information about the content changes made to a library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItem requires System.Read.
get Get Item Changes
Returns information about a library item change. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItem requires System.Read.
Item Download Session
get List Item Download Session
Lists the identifiers of the download sessions 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.DownloadSession referenced by the parameter libraryItemId requires ContentLibrary.DownloadSession.
post Create Item Download Session
Creates a new download session. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the attribute DownloadSessionModel.library-item-id requires ContentLibrary.DownloadSession.
delete Delete Item Download Session
Deletes a download session. This removes the session and all information associated with it. Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. Download sessions for which there is no download activity or which are complete will automatically be expired and then 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 Item Download Session
Gets the download 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.
post Cancel Item Download Session
Cancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
post Fail Item Download Session
Terminates the download session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to download 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 Item Download Session
Keeps a download session alive. This operation is allowed only if the session is in the ACTIVE state. If there is no activity for a download session for a certain period of time, the download session will expire. The download 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 an active download session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Item File
get List Item File
Lists all of the files that are stored within a given library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.
get Get Item File
Retrieves the information for a single file in a library item by its name. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires System.Read.
Item Storage
get List Item Storage
Lists all storage items for a given library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.
get Get Item Storage
Retrieves the storage information for a specific file in a library item. if you do not have all of the privileges described as follows: - The resource com.vmware.content.library.Item referenced by the parameter libraryItemId requires ContentLibrary.ReadStorage.
Item Update Session
get List 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.
post 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.
patch Update Item Update Session
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.
delete Delete Item Update Session
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 Item Update Session
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.
post Cancel Item Update Session
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 Item Update Session
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 Fail Item Update Session
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 Item Update Session
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.
Item Downloadsession File
get List Item Downloadsession File
Lists the information of all the files in the library item associated with the download session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
get Get Item Downloadsession File
Retrieves file download information for a specific file. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
post Prepare Item Downloadsession File
Requests a file to be prepared for download. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Item Updatesession File
get List Item Updatesession File
Lists all files in the library item associated with the update session. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
post Add Item Updatesession File
Requests file content to be changed (either created, or updated). Depending on the source type of the file, this operation will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this operation will be used to update the content of the existing file. When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
get Get Item Updatesession File
Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
post Remove Item Updatesession File
Requests a file to be removed. The file will only be effectively removed when the update session is completed. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
post Validate Item Updatesession File
Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this operation will return its name in the File.ValidationResult.missing-files set. The user can add the missing files and try re-validating. For other type of errors, File.ValidationResult.invalid-files will contain the list of invalid files. if you do not have all of the privileges described as follows: - Operation execution requires System.Anonymous.
Feedback

Was this page helpful?