Resolve Defined Entity

Resolve Defined Entity

Validates the defined entity against the entity type schema. If the validation is successful, the entity will transition to a "RESOLVED" state. Otherwise, it will transition to an "ERROR" state.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/entities/{id}/resolve
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EntityState of type(s) application/json;version=40.0 
{
    "id": "urn:vcloud:entity:vmware.vspheresddc:1.0.0:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "entity": {
        "entity": {}
    },
    "state": "string",
    "entityState": "string",
    "message": "string"
}
string
id
Optional

The id of the defined entity in URN format.

object
entity
Optional

A JSON entity. This entity will be validated against the provided entityType.

string
state
Optional

The current state of the entity

Possible values are : RESOLVED, RESOLUTION_ERROR,
string
entityState
Optional

The "entityState" field may have the following values: "RESOLVED", "RESOLUTION_ERROR". It represents the current state of the entity.

string
message
Optional

The error message(s), if the entity could not be resolved.


Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object]
Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/entities/{id}/resolve
Availability
Added in 35.0
On This Page
Defined Entity Operations
POST
Migrate Defined Entities Of Type
GET
Get Defined Entity
PUT
Update Defined Entity
DELETE
Delete Defined Entity
GET
Get Defined Entity Full Contents
POST
Resolve Defined Entity
GET
Get Metadata
POST
Create Metadata Entry
GET
Get Metadata Entry
PUT
Update Metadata Entry
DELETE
Delete Metadata Entry
GET
Get Metadata File Content
GET
Get Defined Entities By Entity Type Id
GET
Get Defined Entities By Entity Type
GET
Get Defined Entities By Entity Type No Version Specified
GET
Get Defined Entities By Interface
GET
Get Defined Entities By Interface Id