Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

post/workspaces/{workspaceId}/entity-properties/history

Path parameters

workspaceIdstring required

The ID of the workspace.

Request body

entityIdstring

The ID of the entity.

componentNamestring

The name of the component.

componentPathstring

This string specifies the path to the composite component, starting from the top-level component.

componentTypeIdstring

The ID of the component type.

selectedPropertiesString[] required

A list of properties whose value histories the request retrieves.

startDateTimestring date-time

supports epoch seconds value

endDateTimestring date-time

supports epoch seconds value

nextTokenstring

The string that specifies the next page of results.

maxResultsinteger
<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
orderByTime'ASCENDING' | 'DESCENDING'

The time direction to use in the result order.

startTimestring

Timestamp represented in ISO 8601 format

endTimestring

Timestamp represented in ISO 8601 format

Response

Success

nextTokenstring

The string that specifies the next page of results.