Returns the metadata of the info field, such as the unit or the display name and the comment for a selected time period store.

Message "GetHdTimePeriodMetaDataRequest"

Structure

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

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 are to be returned.

3

meta_ids

int32

The IDs for which the metadata should be returned

The associated metadata ID of a time period is part of the GetHdTimePeriodData() response, see GetHdTimePeriodData().

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 "GetHdTimePeriodMetaDataResponse"

List of available metadata definitions of user-defined info fields for the selected meta ID within the requested time period store. A message MetadataField with the following parameters is returned for each metadata definition.

Structure

To copy the code to the clipboard click on the icon -> 
GetHdTimePeriodMetaDataResponse{
   MetadataField{…}
}

Parameter

Pos.

Parameter

Data type

Meaning

1

metadata_id

int32

ID of the metadata group

2

info_field_name

string

Database name of the info field

3

info_field_display_name

string

Display name of the info field

4

comment_1

string

Comment

5

comment_2

string

Comment

6

info_field_unit

string

Unit of the info field

7

info_field_data_type

enum (InfoFieldDataType)

Info field type, see Enum"InfoFieldDataType".
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