Get Defined Entity

Gets the defined entity with the unique identifier (URN)

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/entities/{id}

COPY

Path Parameters

string

Required

string

Required

Query Parameters

string

entityVersion

Optional

Requests that the entity is returned in the specified version of its type. The classification of the requested type must be the same as the current entity type, only the version may differ. The returned entity contents will be converted to the requested type version according to the 'required', 'additionalProperties', and 'default' properties of the type versions schema. If the entity is RESOLVED, then the converted entity will be re-validated against the requested type version and an error may be returned if the validation fails. The conversion only affects the returned contents. The entity itself is not modified. To modify the version of the entity permanently, one must update it with a spec of a newer version or perform an upgrade/mass upgrade request.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns DefinedEntity of type(s) application/json;version=37.2

{
    "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",
    "entityState": "string",
    "owner": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    }
}

string

Optional

The id of the defined entity in URN format.

string

entityType

Optional

The URN ID of the defined entity type that the entity is an instance of. This is a read-only field.

string

name

Required

The name of the defined entity.

string

externalId

Optional

An external entity's id that this entity may have a relation to.

object

entity

Required

A JSON value representation. The JSON will be validated against the schema of the entityType that the entity is an instance of.

string

state

Optional

Every entity is created in the "PRE_CREATED" state. Once an entity is ready to be validated against its schema, it will transition in another state - RESOLVED, if the entity is valid according to the schema, or RESOLUTION_ERROR otherwise. If an entity in an "RESOLUTION_ERROR" state is updated, it will transition to the initial "PRE_CREATED" state without performing any validation. If its in the "RESOLVED" state, then it will be validated against the entity type schema and throw an exception if its invalid.

Possible values are : PRE_CREATED, RESOLVED, RESOLUTION_ERROR,

string

entityState

Optional

The "entityState" field may have the following values: "PRE_CREATED", "RESOLVED", "RESOLUTION_ERROR", "IN_DELETION". Every entity is created in the "PRE_CREATED" state. Once an entity is ready to be validated against its schema, it will transition in another state - "RESOLVED", if the entity is valid according to the schema, or "RESOLUTION_ERROR" otherwise. If an entity in an "RESOLUTION_ERROR" state is updated, it will transition to the initial "PRE_CREATED" state without performing any validation. If its in the "RESOLVED" state, then it will be validated against the entity type schema and throw an exception if its invalid. Once an entity is ready to be deleted, if any external resources need to be cleaned up, the entity deletion process can be set up into multiple stages. The entity will transition into state IN_DELETION when the finalization process starts and will be permanently deleted once it completes successfully. If the finalization is not successful, the entity will once it completes successfully. If the finalization is not successful, the entity will remain in IN_DELETION state.

EntityReference

owner

Optional

owner

EntityReference

org

Optional

org

Availability

Added in 35.0

On This Page

Description