Update Defined Entity

Update Defined Entity

Update the defined entity with the unique identifier (URN)

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

id

string
id
Required

id

Query Parameters
string
invokeHooks
Optional

Only users with Admin FullControl access to the Entity Type can pass this parameter. The default value is 'true'.

Request Body
DefinedEntity of type(s) application/json
Optional 
{
    "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"
    }
}
string
id
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 inital "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,
EntityReference
owner
Optional

owner

EntityReference
org
Optional

org

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns DefinedEntity of type(s) application/json;version=36.3 
{
    "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"
    }
}
string
id
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 inital "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,
EntityReference
owner
Optional

owner

EntityReference
org
Optional

org


400

Invalid configuration.

Returns Error of type(s) application/json;version=36.3 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 35.0
On This Page
Defined Entity Operations
POST
Create Defined Entity
POST
Create Metadata Entry
DELETE
Delete Defined Entity
DELETE
Delete Metadata Entry
GET
Get Defined Entities By Entity Type
GET
Get Defined Entities By Interface
GET
Get Defined Entity
GET
Get Metadata
GET
Get Metadata Entry
GET
Get Metadata File Content
POST
Resolve Defined Entity
PUT
Update Defined Entity
PUT
Update Metadata Entry