Iot Sitewise Batch Get Asset Property Value History Entry Structure
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
Type: objectProperties: 8Required: 1
Asset ManagementIndustrial IoTIoTTime Series Data
BatchGetAssetPropertyValueHistoryEntry is a JSON Structure definition published by Amazon IoT SiteWise, describing 8 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$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-history-entry-structure.json",
"name": "BatchGetAssetPropertyValueHistoryEntry",
"description": "<p>Contains information for an asset property historical value entry that is associated with the <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html\">BatchGetAssetPropertyValueHistory</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>."
}
]
},
"startDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time."
}
]
},
"endDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time."
}
]
},
"qualities": {
"allOf": [
{
"$ref": "#/components/schemas/Qualities"
},
{
"description": "The quality by which to filter asset data."
}
]
},
"timeOrdering": {
"allOf": [
{
"$ref": "#/components/schemas/TimeOrdering"
},
{
"description": "<p>The chronological sorting order of the requested information.</p> <p>Default: <code>ASCENDING</code> </p>"
}
]
}
},
"required": [
"entryId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.