---
title: "POST /workspaces/{workspaceId}/entity-properties/value"
method: POST
path: "/workspaces/{workspaceId}/entity-properties/value"
---

# POST /workspaces/{workspaceId}/entity-properties/value

`POST /workspaces/{workspaceId}/entity-properties/value`

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

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

## Path parameters

- `workspaceId` string, required

## Request body

- object
  - `componentName` string — The name of the component whose property values the operation returns.
  - `componentPath` string — This string specifies the path to the composite component, starting from the top-level component.
  - `componentTypeId` string — The ID of the component type whose property values the operation returns.
  - `entityId` string — The ID of the entity whose property values the operation returns.
  - `selectedProperties` String[], required — The properties whose values the operation returns.
  - `maxResults` integer — <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>
  - `nextToken` string — The string that specifies the next page of results.
  - `propertyGroupName` string — The property group name.
  - `tabularConditions` object — The tabular conditions.
    - `orderBy` OrderBy[] — Filter criteria that orders the output. It can be sorted in ascending or descending order.
      - `order` 'ASCENDING' | 'DESCENDING' — The set order that filters results.
      - `propertyName` string, required — The property name.
    - `propertyFilters` PropertyFilter[] — <p>You can filter the request using various logical operators and a key-value format. For example:</p> <p> <code>{"key": "serverType", "value": "webServer"}</code> </p>
      - `propertyName` string — The property name associated with this property filter.
      - `operator` string — The operator associated with this property filter.
      - `value` object — The value associated with this property filter.
        - `booleanValue` boolean — A Boolean value.
        - `doubleValue` number, double — A double value.
        - `integerValue` integer — An integer value.
        - `longValue` integer — A long value.
        - `stringValue` string — A string value.
        - `listValue` DataValue[] — A list of multiple values.
          - `booleanValue` boolean — A Boolean value.
          - `doubleValue` number, double — A double value.
          - `integerValue` integer — An integer value.
          - `longValue` integer — A long value.
          - `stringValue` string — A string value.
          - `listValue` DataValue[] — A list of multiple values.
          - `mapValue` object — An object that maps strings to multiple <code>DataValue</code> objects.
          - `relationshipValue` object — A value that relates a component to another component.
            - `targetEntityId` string — The ID of the target entity associated with this relationship value.
            - `targetComponentName` string — The name of the target component associated with the relationship value.
          - `expression` string — An expression that produces the value.
        - `mapValue` object — An object that maps strings to multiple <code>DataValue</code> objects.
        - `relationshipValue` object — A value that relates a component to another component.
          - `targetEntityId` string — The ID of the target entity associated with this relationship value.
          - `targetComponentName` string — The name of the target component associated with the relationship value.
        - `expression` string — An expression that produces the value.

## Response `200`

Success

- GetPropertyValueResponse
  - `propertyValues` object — 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.
  - `nextToken` string — The string that specifies the next page of results.
  - `tabularPropertyValues` TabularPropertyValue[] — A table of property values.
    - PropertyTableValue[]

## Other responses

- `480` — InternalServerException
- `481` — ConnectorFailureException
- `482` — AccessDeniedException
- `483` — ResourceNotFoundException
- `484` — ThrottlingException
- `485` — ValidationException
- `486` — ConnectorTimeoutException

---

[API](https://skmtc.net/aws/apis/iottwinmaker.md) · [All operations](https://skmtc.net/aws/apis/iottwinmaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iottwinmaker/versions/a66a26fd65ea/schema)