Get Defined Entity Types

Get Defined Entity Types

Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/entityTypes/
COPY
Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required

Page to fetch, zero offset.

integer
pageSize
Required

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns DefinedEntityTypes of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlineDefinedEntityTypes1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "urn:vcloud:type:vmware:vspheresddc:1.0.0",
            "name": "vspheresddc",
            "description": "string",
            "nss": "sddc",
            "version": "1.1.0",
            "inheritedVersion": "1.0.0",
            "externalId": "123",
            "schema": {
                "application/json": {
                    "type": "object",
                    "properties": {
                        "rectangle": {
                            "$ref": "#/components/schemas/Rectangle"
                        }
                    },
                    "definitions": {
                        "size": {
                            "type": "number",
                            "minimum": 0
                        },
                        "Rectangle": {
                            "type": "object",
                            "properties": {
                                "a": {
                                    "$ref": "#/components/schemas/size"
                                },
                                "b": {
                                    "$ref": "#/components/schemas/size"
                                }
                            }
                        }
                    }
                }
            },
            "vendor": "vmware",
            "interfaces": [
                "urn:vcloud:interface:vmware.sddc:1.0.0"
            ],
            "hooks": {
                "hooks": {}
            },
            "readonly": false,
            "maxImplicitRight": "urn:vcloud:accessLevel:ReadWrite"
        }
    ]
}

Availability
Added in 35.0
On This Page
Defined Entity Type Operations
POST
Create Defined Entity
POST
Create Defined Entity Type
DELETE
Delete Defined Entity Type
GET
Get Defined Entity Type
GET
Get Defined Entity Types
PUT
Update Defined Entity Type