Content Library Item create

Content Library Item create

Creates a new library item.

A new library item is created without any content. After creation, content can be added through the Content Library Item UpdateSession and Content Library Item Updatesession File resources.

A library item cannot be created in a subscribed library.

Returns an authorization error if you do not have all of the privileges described as follows:

  • The resource com.vmware.content.Library referenced by the property Content Library ItemModel.library_id requires ContentLibrary.AddLibraryItem.
Request
URI
POST
https://{api_host}/api/content/library/item
COPY
Header Parameters
string
Client-Token
Optional

A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation.

If not specified creation is not idempotent.


Request Body

Specification that defines the properties of the new library item.

Content Library ItemModel of type(s) application/json
Required
{
    "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": {
        "status": "string",
        "cert_chain": [
            "string"
        ]
    }
}
string
id
Optional

A unique identifier for this library item.

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

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.Item.

string
library_id
Optional

The identifier of the Content LibraryModel to which this item belongs.

This property must be provided for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property 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 property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.item.Version. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.item.Version.

string As date-time As date-time
creation_time
Optional

The date and time when this library item was created.

This property is not used for the create operation. It will always be present in the response 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 property is optional for the create operation. Leaving it missing or null 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 missing or null during update indicates that the description remains unchanged.

string As date-time As date-time
last_modified_time
Optional

The date and time when the metadata for this library item was last changed.

This property 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 property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.

string As date-time As date-time
last_sync_time
Optional

The date and time when this library item was last synchronized.

This property 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 missing or null for a library item that belongs to a local library.

This property is not used for the create operation. It is optional in the response 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 property is not used for the create operation. It will always be present in the response 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 missing or null or an empty string. The name does not have to be unique, even within the same library.

This property must be provided for the create operation. It will always be present in the response 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 property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.

integer As int64 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 property is not used for the create operation. It is optional in the response 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 property 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 Content Type resource.

This property 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 property 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 missing or null during update indicates that you do not need to detect concurrent updates.

string
source_id
Optional

The identifier of the Content Library ItemModel to which this item is synchronized to if the item belongs to a subscribed library. The value is missing or null for a library item that belongs to a local library.

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

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.library.Item. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.library.Item.

boolean
security_compliance
Optional

Shows the security compliance of Content Library ItemModel.

This property was added in vSphere API 7.0.3.0.

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

certificate_verification_info
Optional

Certificate verification status and Content Library 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 property was added in vSphere API 7.0.3.0.

This property is not used for the create and update operations. It may be present in the result of a get or list operation.

Authentication
This operation uses the following authentication methods.
Responses
201

Identifier of the new library item.

The response will be an identifier for the resource type: com.vmware.content.library.Item.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors InvalidArgument:

  • if one of the following is true for the new library item:

    • name is empty
    • name exceeds 80 characters
    • description exceeds 2000 characters
  • if the clientToken does not conform to the UUID format.

Vapi Std Errors InvalidElementType if the Content Library ItemModel.library_id property of createSpec refers to a subscribed library.

Vapi Std Errors NotAllowedInCurrentState if the content of the library specified by the library ID (see Content Library ItemModel.library_id) property of createSpec has been deleted from the storage backings (see LibraryModel#storageBackings) associated with it.

Vapi Std Errors AlreadyExists if there is already a library item with same name in the library.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
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 Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


404

if the Content Library ItemModel.library_id property of createSpec refers to a library that does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/content/library/item