BatchGetAssetPropertyAggregatesEntry

import type { BatchGetAssetPropertyAggregatesEntry } from "https://aws-api.deno.dev/v0.4/services/iotsitewise.ts?docs=full";

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.

interface BatchGetAssetPropertyAggregatesEntry {

aggregateTypes: AggregateType[];

assetId?: string | null;

endDate: Date | number;

entryId: string;

propertyAlias?: string | null;

propertyId?: string | null;

qualities?: Quality[] | null;

resolution: string;

startDate: Date | number;

timeOrdering?: TimeOrdering | null;

}

§Properties

aggregateTypes: AggregateType[]

[src]

The data aggregating function.

assetId?: string | null

[src]

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

endDate: Date | number

[src]

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

entryId: string

[src]

The ID of the entry.

propertyAlias?: string | null

[src]

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.

propertyId?: string | null

[src]

The ID of the asset property.

qualities?: Quality[] | null

[src]

The quality by which to filter asset data.

resolution: string

[src]

The time interval over which to aggregate data.

startDate: Date | number

[src]

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

timeOrdering?: TimeOrdering | null

[src]

The chronological sorting order of the requested information.

Default: ASCENDING