GetHdStores()

This call returns a list of the server's HD stores. Time-based and event-based HD stores and time period stores are supported. Length-based HD stores are not included.

Message "GetHdStoreRequest"

Structure

To copy the code to the clipboard click on the icon ->

GetHdStoresRequest{
}

Parameters

Pos.	Parameter	Data type	Meaning
1	include_diagnostic_stores	bool	Adds diagnostic stores that are hidden by default.

Message "GetHdStoreResponse"

Lists all available time and event-based HD stores, as well as time period stores.

Structure

To copy the code to the clipboard click on the icon ->

GetHdStoresResponse{
   HdStore{…}
   HdStore{…}
   …
}

Parameters

One HdStore message with the following parameters is returned for each store.

Pos.	Parameter	Data type	Meaning
1	hd_store_name	string	Name of the HD store, which is also used in the first part of a fully qualified channel ID.
2	hd_store_type	enum(HdStoreType)	The store type determines which type of data (time series or events) can be retrieved from the store, see Enum"HdStoreType".
3	enabled	bool	State of the store Data can only be retrieved from stores with the parameter enabled = TRUE.
4	active	bool	Returns whether data is currently being written to the store.
5	is_backup	bool	Returns whether the file is an attached backup.
6	hd_store_parent	string	Name of the parent store to which this store belongs. Is used, for example, for time period stores or diagnostic stores.

Enum"HdStoreType"

The following values are available for the HdStoreType parameter:

Value		Meaning
0	HD_STORE_TYPE_UNSPECIFIED	Not specified
1	HD_STORE_TYPE_TIME	Time-based HD store
2	HD_STORE_TYPE_EVENT	Event-based HD store
3	HD_STORE_TYPE_TIME_PERIOD	Time period store
4	HD_STORE_TYPE_ALARM_EVENT	Alarms & Events store