This API has a deprecated equivalent from v7.0U1.
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.
Request
URLURL
https://{api_host}/api/content/library/item/{library_item_id}?action=publish
Path Parameters
Path Parameters
string
library_item_id
Required
Library item identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
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
LibraryItemPublishRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"force_sync_content": false
}
boolean
force_sync_content
Required
Whether to synchronize file content as well as metadata. This parameter applies only if the subscription is on-demand.
array of
LibraryItemDestinationSpec
subscriptions
Optional
The list of subscriptions to publish this library item to.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If one or more arguments in subscriptions is not valid. | com.vmware.vapi.std.errors.invalid_element_type : If the library item specified by libraryItemId is a member of a subscribed library. | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the library item specified by libraryItemId does not belong to a published library.
401
com.vmware.vapi.std.errors.unauthenticated : If the user that requested the operation cannot be authenticated.
403
com.vmware.vapi.std.errors.unauthorized : If the user that requested the operation is not authorized to perform the operation.
404
com.vmware.vapi.std.errors.not_found : If the library item specified by libraryItemId does not exist.
500
com.vmware.vapi.std.errors.error : If the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LibraryItemPublishRequestBody = Initialize-LibraryItemPublishRequestBody -ForceSyncContent $false
Invoke-PublishLibraryItemId -LibraryItemId "MyLibraryItemId" -LibraryItemPublishRequestBody $LibraryItemPublishRequestBody
PowerCLI Client SDK All Parameters Example
$LibraryItemDestinationSpec = Initialize-LibraryItemDestinationSpec -Subscription "MySubscription"
$LibraryItemPublishRequestBody = Initialize-LibraryItemPublishRequestBody -ForceSyncContent $false -Subscriptions $LibraryItemDestinationSpec
Invoke-PublishLibraryItemId -LibraryItemId "MyLibraryItemId" -LibraryItemPublishRequestBody $LibraryItemPublishRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"force_sync_content":false,"subscriptions":[{"subscription":"string"}]}' https://{api_host}/api/content/library/item/{library_item_id}?action=publish
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/id:{library_item_id}?~action=publish
x-vmw-doc-operation: publish
Availability
Added in 7.0U2
On This Page
Item Operations
post
delete
get
patch
post
post
post
get
