Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.

post/workspaces/{workspaceId}/entity-properties/value

Path parameters

workspaceIdstring required

The ID of the workspace whose values the operation returns.

Request body

componentNamestring

The name of the component whose property values the operation returns.

componentPathstring

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

componentTypeIdstring

The ID of the component type whose property values the operation returns.

entityIdstring

The ID of the entity whose property values the operation returns.

selectedPropertiesString[] required

The properties whose values the operation returns.

maxResultsinteger
<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
nextTokenstring

The string that specifies the next page of results.

propertyGroupNamestring

The property group name.

Response

Success

propertyValuesobject

An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

nextTokenstring

The string that specifies the next page of results.