ContentLibrary

ContentLibrary
ContentLibrary

An object representing a VCF Content Library.

JSON Example undefined undefined 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "org": {
        "name": "string",
        "id": "string"
    },
    "libraryType": "string",
    "isSubscribed": false,
    "isShared": false,
    "creationDate": "string",
    "storageClasses": [
        {
            "name": "string",
            "id": "string",
            "region": {
                "name": "string",
                "id": "string"
            }
        }
    ],
    "isProjectScoped": false,
    "allProjectsPermission": "string",
    "projectPermissions": [
        {
            "permissions": "string",
            "projectAssignment": {
                "name": "string",
                "id": "string"
            }
        }
    ],
    "versionNumber": 0,
    "subscriptionConfig": {
        "subscriptionUrl": "string",
        "password": "string",
        "needLocalCopy": false
    },
    "autoAttach": false,
    "status": "READY, NOT_READY, FAILED, PARTIALLY_READY"
}
string
id
Optional

A unique identifier for the Content library.

string
name
Required

The name of the Content Library.

string
description
Optional

The description of the Content Library.

EntityReference
org
Optional

Entity reference used to describe VCD entities

string
libraryType
Optional

The type of content library.

  • PROVIDER - Content Library that is scoped to a provider.
  • TENANT - Content Library that is scoped to an organization.

boolean
isSubscribed
Optional

Whether this Content Library is subscribed from an external published library.

boolean
isShared
Optional

Whether this Content Library is shared with other organziations.

string As date-time As date-time
creationDate
Optional

The ISO-8601 timestamp representing when this Content Library was created.

array of StorageClassWithRegion
storageClasses
Optional
Constraints: maxItems: 48

A collection of storage class references used by this Content Library.

boolean
isProjectScoped
Optional

Whether this content library is scoped to specific projects in this organization.

string
allProjectsPermission
Optional

Permissions to apply to all projects in this organization for this Content Library.

array of ProjectPermission
projectPermissions
Optional

A collection of project permissions for this Content Library. In POST requests, this field may be supplied as an unbounded list. In PUT requests, this field is considered read-only and will be ignored. In GET responses, this field contains a random selection of up to ten project permissions that exist for this Content Library.

integer As int64 As int64
versionNumber
Optional

Version number of this Content library.

ContentLibrarySubscriptionConfig
subscriptionConfig
Optional

An object representing subscription settings of a Content Library.

boolean
autoAttach
Optional
Constraints: default: true

For Organization Content Libraries this field represents whether this Content Library should be automatically attached to all current and future namespaces in the organization. If no value is supplied during Organization Content Library creation then this field will default to true. If a value of false is supplied, then this Organization Content Library will only be attached to namespaces that explicitly request it. For Provider Content Libraries and Project Content Libraries this field is not needed for creation and will always be returned as true. This field cannot be updated after Content Library creation.

string
status
Optional

Status of this content library.

Parameter To
Returned By