Documentation

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates 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.

See: newBatchGetAssetPropertyAggregatesEntry smart constructor.

Create a value of BatchGetAssetPropertyAggregatesEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assetId:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_assetId - The ID of the asset in which the asset property was created.

$sel:propertyAlias:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_propertyAlias - The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

$sel:propertyId:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_propertyId - The ID of the asset property.

$sel:qualities:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_qualities - The quality by which to filter asset data.

$sel:timeOrdering:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_timeOrdering - The chronological sorting order of the requested information.

Default: ASCENDING

$sel:entryId:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_entryId - The ID of the entry.

$sel:aggregateTypes:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_aggregateTypes - The data aggregating function.

$sel:resolution:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_resolution - The time interval over which to aggregate data.

$sel:startDate:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_startDate - The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

$sel:endDate:BatchGetAssetPropertyAggregatesEntry', batchGetAssetPropertyAggregatesEntry_endDate - The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

The ID of the asset in which the asset property was created.

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

The ID of the asset property.

The quality by which to filter asset data.

The chronological sorting order of the requested information.

Default: ASCENDING

The ID of the entry.

The data aggregating function.

The time interval over which to aggregate data.

The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.