Informational - ConfigParamDefDoc

The ConfigParamDefDoc document is an informational document that defines the parameter logged within the context of a config doc and their related logged frequencies.

Field Data Type Required Default Description
id String Yes - A unique identifier that is referenced by all other documents see section Unique Id Generation.
configDocId String Yes - The unique identifier (id) of the ConfigDoc with which this this document is associated.
paramDefDocId String Yes - The unique identifier (id) of the ParamDefinitionDoc with which this this document is associated.
format String No %5.1f A c-style format string used to describe the intended format of the stored raw value.
unitConversion String No Value*1 A free form string describing calculation for the unit conversion used for this instance of the parameter.
units String No - A free form string describing the units associated with the data values stored in this document.
min 64-bit Double No - The warning minimum value for the parameter associated with this document.
max 64-bit Double No - The warning maximum value for the parameter associated with this document.
frequencies Array [64-bit Double] Yes - An array of 64-bit Double values, with each value representing the frequency that is defined by a parameter.
identityDocIds String No - An array of the unique identifiers (id) of each associated IdentityDoc document.
tags Array [String, String] No - An array of key/pair free form string values. Used to store meta data related to the data stored by this document.
type Fixed String Fixed ConfigParamDefDoc The fixed value is always set to ConfigParamDefDoc.