Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

This API lists the components of an entity.

post/workspaces/{workspaceId}/entities/{entityId}/components-list

Path parameters

workspaceIdstring required

The workspace ID.

entityIdstring required

The ID for the entity whose metadata (component/properties) is returned by the operation.

Request body

componentPathstring

This string specifies the path to the composite component, starting from the top-level component.

maxResultsinteger

The maximum number of results returned at one time. The default is 25.

nextTokenstring

The string that specifies the next page of results.

Response

Success

nextTokenstring

The string that specifies the next page of component results.