Content Library Usages get

Retrieves the library usage information for a given usage identifier.

This operation was added in vSphere API 9.1.0.0.

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

Operation execution requires System.Read.

Request

URI

GET

https://{host}/api/content/library/{library}/usages/{usage}

COPY

Path Parameters

string

library

Required

The identifier of the content library.

The parameter must be an identifier for the resource type: com.vmware.content.Library.

string

usage

Required

The identifier of the content library usage.

The parameter must be an identifier for the resource type: com.vmware.content.library.Usages.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Information about the usage on a content library.

Returns Content Library Usages Info of type(s) application/json

{
    "usage": "string",
    "resource_urn": "string",
    "addition_time": "string"
}

string

usage

Required

The identifier of the usage on a content library.

This property was added in vSphere API 9.1.0.0.

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.Usages. 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.Usages.

string As uri As uri

resource_urn

Required

The Uniform Resource Name (URN) of the resource that is using the content library.

This property was added in vSphere API 9.1.0.0.

string As date-time As date-time

addition_time

Required

The date and time when the usage got added on the content library.

This property was added in vSphere API 9.1.0.0.

401

If the user that requested the operation cannot be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: Vapi Std Errors Error

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Vapi Std LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string",
    "challenge": "string"
}

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

If the user that requested the operation is not authorized to perform the operation.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: Vapi Std Errors Error

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string",
    "challenge": "string"
}

string

challenge

Optional

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da158-2ba4-11e9-b",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 9.1.0.0.

This property is optional because it was added in a newer version than its parent node.

404

If the content library specified by library does not exist.
If content library usage specified by usage does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: Vapi Std Errors Error

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/content/library/{library}/usages/{usage}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Content Operations

GET

Content Library Usages list

POST

Content Library Usages add

GET

Content Library Usages get

DELETE

Content Library Usages remove