Update Defined Entity
Update the defined entity with the unique identifier (URN). This operation can also be used to upgrade/downgrade the entity to a different version of the defined entity type it is an instance of by setting the "entityType" property.
The update operation may change the entityState of the Defined Entity. If the entity's entityState is:
- PRE_CREATED before the update - the entity will remain in PRE_CREATED entityState after the update
- RESOLUTION_ERROR before the update - the entity will move to PRE_CREATED entityState after the update
- IN_DELETION before the update - the entity will remain in IN_DELETION entityState after the update
- RESOLVED before the update - the update operation will try to validate the entity content (value after the update) against the entity type's schema (value after the update). If validation is successful the entity will remain in RESOLVED state. Otherwise, the entity will move to RESOLUTION_ERROR entityState and the operation will fail with exception.
id
id
Only users with Admin FullControl access to the Entity Type can pass this parameter. The default value is 'true'.
{
"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",
"entity": {
"entity": {}
},
"state": "string",
"entityState": "string",
"creationDate": "string",
"lastModificationDate": "string",
"owner": {
"name": "string",
"id": "string"
},
"org": {
"name": "string",
"id": "string"
}
}The id of the defined entity in URN format.
The URN ID of the defined entity type that the entity is an instance of. This is a read-only field.
The name of the defined entity.
An external entity's id that this entity may have a relation to.
A JSON value representation. The JSON will be validated against the schema of the entityType that the entity is an instance of.
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.
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.
The date that the entity was created.
The date that the entity was last modified.
Ok
{
"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",
"entity": {
"entity": {}
},
"state": "string",
"entityState": "string",
"creationDate": "string",
"lastModificationDate": "string",
"owner": {
"name": "string",
"id": "string"
},
"org": {
"name": "string",
"id": "string"
}
}The id of the defined entity in URN format.
The URN ID of the defined entity type that the entity is an instance of. This is a read-only field.
The name of the defined entity.
An external entity's id that this entity may have a relation to.
A JSON value representation. The JSON will be validated against the schema of the entityType that the entity is an instance of.
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.
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.
The date that the entity was created.
The date that the entity was last modified.
The request have been accepted and the task to monitor the request is in the Location header.
Invalid configuration.
{
"minorErrorCode": "string",
"message": "string",
"stackTrace": "string"
}minorErrorCode
message
stackTrace