EntityPropertyReference

An object that uniquely identifies an entity property.

3D VisualizationDigital TwinIndustrial IoTIoT

Properties

Name Type Description
componentName object
externalIdProperty object
entityId object
propertyName object
View JSON Schema on GitHub

JSON Schema

iot-twinmaker-entity-property-reference-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/json-schema/iot-twinmaker-entity-property-reference-schema.json",
  "title": "EntityPropertyReference",
  "description": "An object that uniquely identifies an entity property.",
  "type": "object",
  "properties": {
    "componentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the component."
        }
      ]
    },
    "externalIdProperty": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ExternalIdProperty"
        },
        {
          "description": "A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores."
        }
      ]
    },
    "entityId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityId"
        },
        {
          "description": "The ID of the entity."
        }
      ]
    },
    "propertyName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the property."
        }
      ]
    }
  },
  "required": [
    "propertyName"
  ]
}