Content Library Item Updatesession File get
Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Anonymous.
Identifier of the update session.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
Name of the file.
Information about the file.
{
"name": "string",
"source_type": "string",
"size": 0,
"checksum_info": {
"algorithm": "string",
"checksum": "string"
},
"source_endpoint": {
"uri": "string",
"ssl_certificate_thumbprint": "string",
"ssl_certificate": "string"
},
"upload_endpoint": {
"uri": "string",
"ssl_certificate_thumbprint": "string",
"ssl_certificate": "string"
},
"bytes_transferred": 0,
"status": "string",
"error_message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"keep_in_storage": false
}The name of the file.
The source type (SourceType) from which the file is being retrieved. This may be Content Library Item Updatesession File SourceType.NONE if the file is not being changed.
For more information see: Content Library Item Updatesession File SourceType.
The file size, in bytes as received by the server. This property is guaranteed to be set when the server has completely received the file.
This property won't be set until the file status is Content Library Item TransferStatus.READY.
The checksum information of the file received by the server.
If missing or null, the server does not verify the checksum.
A source endpoint from which to retrieve the file.
This property is optional and it is only relevant when the value of source_type is Content Library Item Updatesession File SourceType.PULL.
An upload endpoint to which the client can push the content.
This property is optional and it is only relevant when the value of source_type is Content Library Item Updatesession File SourceType.PUSH.
The number of bytes of this file that have been received by the server.
The transfer status (TransferStatus) of this file.
For more information see: Content Library Item TransferStatus.
Details about the transfer error.
An error message is set if the status is Content Library Item TransferStatus.ERROR.
Whether or not the file will be kept in storage upon update session completion. The flag is true for most files, and false for metadata files such as manifest and certificate file of update session with library item type OVF. Any file with Content Library Item Updatesession File Info.keep_in_storage set to false will not show up in the list of files returned from GET /content/library/item/{libraryItemId}/file upon update session completion.
This property was added in vSphere API 6.8.
If missing or null, the file will be kept in storage upon update session completion.
if the file doesn't exist in the library item associated with the update session.
"Vapi Std Errors InvalidArgument Object"if the update session doesn't exist.
"Vapi Std Errors NotFound Object" curl -H 'Authorization: <value>' https://{api_host}/api/content/library/item/update-session/{updateSessionId}/file/{fileName}