Returns the list of all available info fields and their properties as a schema for the selected time period store.

Message "GetHdTimePeriodStoreSchemaRequest"

Structure

To copy the code to the clipboard click on the icon -> 
GetHdTimePeriodStoreSchemaRequest{
}

Parameter

Pos.

Parameter

Data type

Meaning

1

hd_store_name

string

Unique name of the time-based HD store, which is the parent store for the time period store

2

time_period_store_name

string

Unique name of the time period store whose info fields and schema are to be returned

3

include_standard_fields

bool

Option to integrate the standard info fields into the message. User-defined info fields are always returned.

4

locale

string

For later use: Option to return the display name of the fields in a desired language.

If empty, the system language of ibaHD-Server is returned.
Message "GetHdTimePeriodStoreSchemaResponse"

List of available info fields in the time period store. A message InfoFieldDefinition with the following parameters is returned for each info field.

Structure

To copy the code to the clipboard click on the icon -> 
GetHdTimePeriodStoreSchemaResponse{
   InfoFieldDefinition{…}
}

Parameter

Pos.

Parameter

Data type

Meaning

1

info_field_data_type

enum (InfoFieldDataType)

Type of the info field, see Enum"InfoFieldDataType".

2

field_name

string

Name of the info field

3

display_name

string

Localized display name of the info field
Enum"InfoFieldDataType"

The following values are available for InfoFieldDataType.

Value

Meaning

0

IF_DATA_TYPE_UNSPECIFIED

Not specified

1

IF_DATA_TYPE_FLOAT_VALUES

Value of type "float"

2

IF_DATA_TYPE_DOUBLE_VALUES

Value of type "double"

3

IF_DATA_TYPE_STRING_VALUES

Value of type "string"

4

IF_DATA_TYPE_BOOL_VALUES

Value of type "bool"

5

IF_DATA_TYPE_INT16_VALUES

int16 value

6

IF_DATA_TYPE_INT32_VALUES

int32 value

7

IF_DATA_TYPE_INT64_VALUES

int64 value