This API has a deprecated equivalent from v7.0U1.
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.
Request
URLURL
https://{api_host}/api/content/library/item/update-session/{update_session_id}/file/{file_name}
Path Parameters
Path Parameters
string
update_session_id
Required
Identifier of the update session. The parameter must be an identifier for the resource type: com.vmware.content.library.item.UpdateSession.
string
file_name
Required
Name of the file.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
LibraryItemUpdatesessionFileInfo of type application/json
Information about the file.
{
"bytes_transferred": 0,
"checksum_info": {
"algorithm": "SHA1",
"checksum": "string"
},
"error_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"keep_in_storage": false,
"name": "string",
"size": 0,
"source_endpoint": {
"ssl_certificate_thumbprint": "string",
"uri": "string"
},
"source_type": "NONE",
"status": "WAITING_FOR_TRANSFER",
"upload_endpoint": {
"ssl_certificate_thumbprint": "string",
"uri": "string"
}
}
integer
bytes_transferred
Required
The number of bytes of this file that have been received by the server.
source_type
Required
The File.SourceType enumerated type defines how the file content is retrieved.
NONE : No source type has been requested.
PUSH : The client is uploading content using HTTP(S) PUT requests.
PULL : The server is pulling content from a URL. The URL scheme can be http, https, file, or ds.
Possible values are: NONE , PUSH , PULL
status
Required
The TransferStatus enumerated type defines the transfer state of a file.
WAITING_FOR_TRANSFER : Indicates that a file has been defined for a library item and its content needs to be uploaded.
TRANSFERRING : Indicates that data is being transferred to the file.
READY : Indicates that the file has been fully transferred and is ready to be used.
VALIDATING : Indicates that the file is being validated (checksum, type adapters).
ERROR : Indicates that there was an error transferring or validating the file.
Possible values are: WAITING_FOR_TRANSFER , TRANSFERRING , READY , VALIDATING , ERROR
string
name
Required
The name of the file.
boolean
keep_in_storage
Optional
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 File.Info.keep-in-storage set to false will not show up in the list of files returned from File.list upon update session completion. If unset, the file will be kept in storage upon update session completion.
integer
size
Optional
The file size, in bytes as received by the server. This field is guaranteed to be set when the server has completely received the file. This field won’t be set until the file status is READY.
source_endpoint
Optional
A source endpoint from which to retrieve the file. This field is optional and it is only relevant when the value of File.Info.source-type is PULL.
checksum_info
Optional
The checksum information of the file received by the server. If unset, the server does not verify the checksum.
error_message
Optional
Details about the transfer error. An error message is set if the status is ERROR.
upload_endpoint
Optional
An upload endpoint to which the client can push the content. This field is optional and it is only relevant when the value of File.Info.source-type is PUSH.
Code Samples
PowerCLI Client SDK Example
Invoke-GetUpdateSessionIdFileNameItem -UpdateSessionId "MyUpdateSessionId" -FileName "MyFileName"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/item/update-session/{update_session_id}/file/{file_name}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the file doesn’t exist in the library item associated with the update session.
Vendor Extensions
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/updatesession/file/id:{update_session_id}?~action=get
x-vmw-doc-operation: get
Availability
Added in 7.0U2
