Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

Updates an entity.

put/workspaces/{workspaceId}/entities/{entityId}

Path parameters

workspaceIdstring required

The ID of the workspace that contains the entity.

entityIdstring required

The ID of the entity.

Request body

entityNamestring

The name of the entity.

descriptionstring

The description of the entity.

componentUpdatesobject

An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

compositeComponentUpdatesobject

This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.

Response

Success

updateDateTimestring date-time required

The date and time when the entity was last updated.

state'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | 'ERROR' required

The current state of the entity update.