Get Defined Entities By Entity Type

Get Defined Entities By Entity Type

Gets the collection of defined entities for the vCD-defined type with the specified vendor, nss and version. The version can act as a wildcard. If only '1' is specified as the version, all entity types with a major version of '1' will be matched (e.g. 1.0.0, 1.1.2). If '1.0' is specified, all entity types with a major version of '1' and a minor version of '0' will be included (e.g. 1.0.0, 1.0.1). If the full semver is specified, then no search will be performed.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/entities/types/{vendor}/{nss}/{version}
COPY
Path Parameters
string
vendor
Required

vendor

string
nss
Required

nss

string
version
Required

version

string
vendor
Required

vendor

string
nss
Required

nss

string
version
Required

version

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.

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 DefinedEntities of type(s) application/json;version=36.3
This response body class contains all of the following: Page , InlineDefinedEntities1
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "urn:vcloud:entity:vmware.vspheresddc:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "entityType": "urn:vcloud:type:vmware.vspheresddc:1.0.0",
            "name": "vspheresddc1",
            "externalId": "123",
            "state": "string",
            "owner": {
                "name": "string",
                "id": "string"
            },
            "org": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}