Iot Twinmaker Entity Property Reference Structure

An object that uniquely identifies an entity property.

Type: object Properties: 4 Required: 1

3D VisualizationDigital TwinIndustrial IoTIoT

EntityPropertyReference is a JSON Structure definition published by Amazon IoT TwinMaker, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

componentName externalIdProperty entityId propertyName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/json-structure/iot-twinmaker-entity-property-reference-structure.json",
  "name": "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"
  ]
}