Amazon IoT SiteWise · JSON Structure

Iot Sitewise Batch Get Asset Property Value Entry Structure

Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.

To identify an asset property, you must specify one of the following:

Type: object Properties: 4 Required: 1
Asset ManagementIndustrial IoTIoTTime Series Data

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

Properties

entryId assetId propertyId propertyAlias

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-batch-get-asset-property-value-entry-structure.json",
  "name": "BatchGetAssetPropertyValueEntry",
  "description": "<p>Contains information for an asset property value entry that is associated with the <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html\">BatchGetAssetPropertyValue</a> API.</p> <p>To identify an asset property, you must specify one of the following:</p> <ul> <li> <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p> </li> <li> <p>A <code>propertyAlias</code>, which is a data stream alias (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html\">UpdateAssetProperty</a>.</p> </li> </ul>",
  "type": "object",
  "properties": {
    "entryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntryId"
        },
        {
          "description": "The ID of the entry."
        }
      ]
    },
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset in which the asset property was created."
        }
      ]
    },
    "propertyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset property."
        }
      ]
    },
    "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>."
        }
      ]
    }
  },
  "required": [
    "entryId"
  ]
}