Get Library Item Id Content

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.

Request

URI

GET

https://{api_host}/api/content/library/item/{library_item_id}

COPY

Path Parameters

string

library_item_id

Required

Identifier of the library item to return. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

The ItemModel instance with the given libraryItemId.

Returns Library_ItemModel of type(s) application/json

{
    "id": "string",
    "library_id": "string",
    "content_version": "string",
    "creation_time": "string",
    "description": "string",
    "last_modified_time": "string",
    "last_sync_time": "string",
    "metadata_version": "string",
    "name": "string",
    "cached": false,
    "size": 0,
    "type": "string",
    "version": "string",
    "source_id": "string",
    "security_compliance": false,
    "certificate_verification_info": "Library_Item_CertificateVerificationInfo Object"
}

string

Optional

A unique identifier for this library item. This field is not used for the create operation. It will not be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.

string

library_id

Optional

The identifier of the LibraryModel to which this item belongs. This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.

string

content_version

Optional

The latest version of the file content list of this library item. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.item.Version. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.item.Version.

string As date-time

creation_time

Optional

The date and time when this library item was created. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.

string

description

Optional

A human-readable description for this library item. This field is optional for the create operation. Leaving it unset during creation will result in an empty string value. It will always be present in the result of a get or list operation. It is optional for the update operation. Leaving it unset during update indicates that the description remains unchanged.

string As date-time

last_modified_time

Optional

The date and time when the metadata for this library item was last changed. This field is affected by changes to the properties or file content of this item. It is not modified by changes to the tags of the item, or by changes to the library which owns this item.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.

string As date-time

last_sync_time

Optional

The date and time when this library item was last synchronized. This field is updated every time a synchronization is triggered on the library item, including when a synchronization is triggered on the library to which this item belongs. The value is unset for a library item that belongs to a local library.

This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.

string

metadata_version

Optional

A version number for the metadata of this library item. This value is incremented with each change to the metadata of this item. Changes to name, description, and so on will increment this value. The value is not incremented by changes to the content or tags of the item or the library which owns it.

This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.

string

name

Optional

A human-readable name for this library item. The name may not be unset or an empty string. The name does not have to be unique, even within the same library.

This field must be provided for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

boolean

cached

Optional

The status that indicates whether the library item is on disk or not. The library item is cached when all its files are on disk. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is not used for the update operation.

integer As int64

size

Optional

The library item size, in bytes. The size is the sum of the size used on the storage backing for all the files in the item. When the library item is not cached, the size is 0. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation.

string

type

Optional

An optional type identifier which indicates the type adapter plugin to use. This field may be set to a non-empty string value that corresponds to an identifier supported by a type adapter plugin present in the Content Library Service. A type adapter plugin, if present for the specified type, can provide additional information and services around the item content. A type adapter can guide the upload process by creating file entries that are in need of being uploaded to complete an item.

The types and plugins supported by the Content Library Service can be queried using the Type service.

This field is optional for the create and update operations. During creation, if the type is left unspecified, or if the type is specified but does not have a corresponding type support plugin, then the type of the library item is considered to be generic and all data is treated as generic files. During update, if the type is not specified, then it is not updated.

string

version

Optional

A version number that is updated on metadata changes. This value is used to validate update requests to provide optimistic concurrency of changes. This value represents a number that is incremented every time library item properties, such as name or description, are changed. It is not incremented by changes to the file content of the library item, including adding or removing files. It is also not affected by tagging the library item.

This field is not used for the create operation. It will always be present in the result of a get or list operation. It is optional for the update operation. Leaving it unset during update indicates that you do not need to detect concurrent updates.

string

source_id

Optional

The identifier of the ItemModel to which this item is synchronized to if the item belongs to a subscribed library. The value is unset for a library item that belongs to a local library. This field is not used for the create operation. It is optional in the result of the get or list operations. It is not used for the update operation. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Item.

boolean

security_compliance

Optional

Shows the security compliance of ItemModel. This field is not used for the create and update operations. It will be present in the result of a get or list operation.

Library_Item_CertificateVerificationInfo

certificate_verification_info

Optional

Certificate verification status and ItemModel's signing certificate . Currently, this field is available only in following cases 1. This item belongs to a secure content library 2. The item is of type ovf. This field is not used for the create and update operations. It may be present in the result of a get or list operation.

404

com.vmware.vapi.std.errors.not_found : if no item with the given libraryItemId exists.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "localized": "string"
        }
    ],
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

default

'Default' means this response is used for all HTTP codes that are not covered individually for this operation.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "localized": "string"
        }
    ],
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional