Amazon IoT SiteWise · Schema
BatchGetAssetPropertyValueEntries
BatchGetAssetPropertyValueEntries schema
Asset ManagementIndustrial IoTIoTTime Series Data
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-schema/iot-sitewise-batch-get-asset-property-value-entries-schema.json",
"title": "BatchGetAssetPropertyValueEntries",
"description": "BatchGetAssetPropertyValueEntries schema",
"type": "array",
"items": {
"type": "object",
"required": [
"entryId"
],
"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>."
}
]
}
},
"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>"
}
}