{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-twinmaker/refs/heads/main/json-schema/iot-twinmaker-get-property-value-history-request-schema.json", "title": "GetPropertyValueHistoryRequest", "description": "GetPropertyValueHistoryRequest schema", "type": "object", "properties": { "entityId": { "allOf": [ { "$ref": "#/components/schemas/EntityId" }, { "description": "The ID of the entity." } ] }, "componentName": { "allOf": [ { "$ref": "#/components/schemas/Name" }, { "description": "The name of the component." } ] }, "componentTypeId": { "allOf": [ { "$ref": "#/components/schemas/ComponentTypeId" }, { "description": "The ID of the component type." } ] }, "selectedProperties": { "allOf": [ { "$ref": "#/components/schemas/SelectedPropertyList" }, { "description": "A list of properties whose value histories the request retrieves." } ] }, "propertyFilters": { "allOf": [ { "$ref": "#/components/schemas/PropertyFilters" }, { "description": "A list of objects that filter the property value history request." } ] }, "startDateTime": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "deprecated": true, "description": "The date and time of the earliest property value to return.This field is deprecated and will throw an error in the future. Use startTime instead." } ] }, "endDateTime": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" }, { "deprecated": true, "description": "The date and time of the latest property value to return.This field is deprecated and will throw an error in the future. Use endTime instead." } ] }, "interpolation": { "allOf": [ { "$ref": "#/components/schemas/InterpolationParameters" }, { "description": "An object that specifies the interpolation type and the interval over which to interpolate data." } ] }, "nextToken": { "allOf": [ { "$ref": "#/components/schemas/NextToken" }, { "description": "The string that specifies the next page of results." } ] }, "maxResults": { "allOf": [ { "$ref": "#/components/schemas/MaxResults" }, { "description": "

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

" } ] }, "orderByTime": { "allOf": [ { "$ref": "#/components/schemas/OrderByTime" }, { "description": "The time direction to use in the result order." } ] }, "startTime": { "allOf": [ { "$ref": "#/components/schemas/Time" }, { "description": "

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" } ] }, "endTime": { "allOf": [ { "$ref": "#/components/schemas/Time" }, { "description": "

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

" } ] } }, "required": [ "selectedProperties" ] }