Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

Creates an entity.

post/workspaces/{workspaceId}/entities

Path parameters

workspaceIdstring required

The ID of the workspace that contains the entity.

Request body

entityIdstring

The ID of the entity.

entityNamestring required

The name of the entity.

descriptionstring

The description of the entity.

componentsobject

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

compositeComponentsobject

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>.

parentEntityIdstring

The ID of the entity's parent entity.

tagsobject

Metadata that you can use to manage the entity.

Response

Success

entityIdstring required

The ID of the entity.

arnstring required

The ARN of the entity.

creationDateTimestring date-time required

The date and time when the entity was created.

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

The current state of the entity.