[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Defined Entity Type

Description

Gets the entity type with the unique identifier (URN)

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/entityTypes/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DefinedEntityType of type(s) application/json;version=36.3
{
    "externalId": "123",
    "id": "urn:vcloud:type:vmware:vspheresddc:1.0.0",
    "inheritedVersion": "1.0.0",
    "interfaces": [
        "urn:vcloud:interface:vmware.sddc:1.0.0"
    ],
    "name": "vspheresddc",
    "nss": "sddc",
    "readonly": false,
    "schema": {
        "application/json": {
            "definitions": {
                "Rectangle": {
                    "properties": {
                        "a": {
                            "$ref": "#/definitions/size"
                        },
                        "b": {
                            "$ref": "#/definitions/size"
                        }
                    },
                    "type": "object"
                },
                "size": {
                    "minimum": 0,
                    "type": "number"
                }
            },
            "properties": {
                "rectangle": {
                    "$ref": "#/definitions/Rectangle"
                }
            },
            "type": "object"
        }
    },
    "vendor": "vmware",
    "version": "1.1.0"
}
string
description Optional

Description of the defined entity type.


string
externalId Optional

An external entity’s id that this definition may apply to.


map of object
hooks Optional

A mapping defining which behaviors should be invoked upon specific lifecycle events, like PostCreate, PostUpdate, PreDelete. For example: “hooks”: { “PostCreate”: “urn:vcloud:behavior-interface:postCreateHook:vendorA:containerCluster:1.0.0” }


string
id Optional

The id of the defined entity type in URN format.


string
inheritedVersion Optional

To be used when creating a new version of a defined entity type. Specifies the version of the type that will be the template for the authorization configuration of a the new version. The Type ACLs and the access requirements of the Type Behaviors of the new version will be copied from those of the inherited version. If the value of this property is ‘0’, then the new type version will not inherit another version and will have the default authorization settings, just like the first version of a new type.


array of string
interfaces Optional

List of interface ids that this defined entity type is referenced by.


string
name Optional

The name of the defined entity type.


string
nss Optional

A unique namespace specific string. The combination of nss and version must be unique.


boolean
readonly Optional

True if the entity type cannot be modified.


map of object
schema Optional

The JSON-Schema valid definition of the defined entity type. If no JSON Schema version is specified, version 4 will be assumed.


string
vendor Optional

The vendor name.


string
version Optional

The version of the defined entity type. The combination of nss and version must be unique. The version string must follow semantic versioning rules.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/entityTypes/{id}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?