Get Library Item

Get Library Item

Retrieves a specific item via URN.

Request
URI
GET
https://{api_host}/cloudapi/vcf/contentLibraryItems/{itemUrn}
COPY
Path Parameters
string
itemUrn
Required

itemUrn


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ContentLibraryItem of type(s) application/json;version=40.0
{
    "id": "string",
    "name": "string",
    "imageIdentifier": "string",
    "description": "string",
    "isPublished": false,
    "isSubscribed": false,
    "creationDate": "string",
    "lastSuccessfulSync": "string",
    "version": 0,
    "status": "READY, NOT_READY, FAILED, PARTIALLY_READY",
    "contentLibrary": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "fileUploadSizeBytes": 0,
    "itemType": "string"
}
string
id
Optional

A unique identifier for the library item.

string
name
Required

The name of the content library item.

string
imageIdentifier
Optional

VirtualMachineIdentifier (VMI) of the item. This is a ReadOnly field.

string
description
Optional

The description of the content library item.

boolean
isPublished
Optional

Whether this item is published.

boolean
isSubscribed
Optional

Whether this item is subscribed.

string As date-time As date-time
creationDate
Optional

The ISO-8601 timestamp representing when this item was created.

string As date-time As date-time
lastSuccessfulSync
Optional

The ISO-8601 timestamp representing when this item was last synced if subscribed.

integer As int64 As int64
version
Optional

The version of this item. For a subscribed library, this version is same as in publisher library.

string
status
Optional

Status of this content library item.

object
contentLibrary
Required

Entity reference used to describe VCD entities

object
org
Optional

Entity reference used to describe VCD entities

integer As int64 As int64
fileUploadSizeBytes
Optional
Constraints: minimum: 1

The size of the content library item file to upload in bytes. This field is only required for ISO content library items and will be NULL for Template based content library items.

string
itemType
Required

The type of content library item. This field is only required for content library upload.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
                
Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/vcf/contentLibraryItems/{itemUrn}