REST API - get
  1. Operations
  2. content
  3. library
  4. item
  5. file

content library item file: get

Retrieves the information for a single file in a library item by its name.

Request:

HTTP request

POST https://{server}/rest/com/vmware/content/library/item/file/id:{library_item_id}?~action=get

Path Parameters

Name Type Description
Required
library_item_id string Identifier of the library item whose file information should be returned.

Request Body Structure:

{
    "name" : "string"
}

Request Body Parameters:

Name Type Description
bold = required
name string Name of the file in the library item whose information should be returned.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "checksum_info" : {
            "checksum" : "string",
            "algorithm" : "SHA1"
        },
        "size" : 1,
        "cached" : true,
        "name" : "string",
        "version" : "string"
    }
}

Response Type:

Name Type Description
bold = required
value info The content.library.item.file.info object with information on the specified file.
value.checksum_info checksum_info A checksum for validating the content of the file.

This value can be used to verify that a transfer was completed without errors.

Optional. A checksum cannot always be calculated, and the value will be unset if the file does not have content.
value.checksum_info.algorithm string The checksum algorithm (SHA1, MD5, SHA256, SHA512) used to calculate the checksum.

Optional. If not specified the default checksum algorithm is SH_a1.
value.checksum_info.checksum string The checksum value calculated with content.library.item.file.checksum_info.algorithm.
value.name string The name of the file.

This value will be unique within the library item for each file. It cannot be an empty string.
value.size long The file size, in bytes. The file size is the storage used and not the uploaded or provisioned size. For example, when uploading a disk to a datastore, the amount of storage that the disk consumes may be different from the disk file size. When the file is not cached, the size is 0.
value.cached boolean Indicates whether the file is on disk or not.
value.version string The version of this file; incremented when a new copy of the file is uploaded.

Errors:

HTTP Status Code Type Description
404 not_found if library_item_id refers to a library item that does not exist.