Amazon IoT SiteWise · JSON Structure

Iot Sitewise Put Asset Property Value Entry Structure

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.

Type: object Properties: 5 Required: 2
Asset ManagementIndustrial IoTIoTTime Series Data

PutAssetPropertyValueEntry is a JSON Structure definition published by Amazon IoT SiteWise, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

entryId assetId propertyId propertyAlias propertyValues

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-put-asset-property-value-entry-structure.json",
  "name": "PutAssetPropertyValueEntry",
  "description": "Contains a list of value updates for an asset property in the list of asset entries consumed by the <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html\">BatchPutAssetPropertyValue</a> API operation.",
  "type": "object",
  "properties": {
    "entryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntryId"
        },
        {
          "description": "The user specified ID for the entry. You can use this ID to identify which entries failed."
        }
      ]
    },
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset to update."
        }
      ]
    },
    "propertyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset property for this entry."
        }
      ]
    },
    "propertyAlias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyAlias"
        },
        {
          "description": "The alias that identifies the property, such as an OPC-UA server data stream path (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html\">Mapping industrial data streams to asset properties</a> in the <i>IoT SiteWise User Guide</i>."
        }
      ]
    },
    "propertyValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssetPropertyValues"
        },
        {
          "description": "The list of property values to upload. You can specify up to 10 <code>propertyValues</code> array elements. "
        }
      ]
    }
  },
  "required": [
    "entryId",
    "propertyValues"
  ]
}