Regno Standard - ConfigParamDefDoc

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	-	Regno unique document identifier.
*type*	Fixed String	No	ConfigParamDefDoc	Type of the document, resolved from fixed document types.
*identityDocIds*	String[]	No	-	An array of the unique identifiers (id) of each associated IdentityDoc.
*configDocId*	String	Yes	-	The unique identifier (id) of the ConfigDoc document that this document is associated with.
*paramDefDocId*	String	Yes	-	An integer value associated with the parameter definition document instance.
*format*	String	No	-	A C style format used to display the parameter data value. See the section Format Strings for details and examples.
*unitConversion*	String	No	-	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.
*frequencies*	Double[]	Yes	-	An array of 64-bit Doubles, specifying frequencies of the embedded ParamDefDoc at time of data capture.
*min*	Double	Yes	-	The minimum display value for the parameter instance for the given configuration.
*max*	Double	Yes	-	The maximum display value for the parameter instance for the given configuration.
*tags*	TagDoc[]	No	-	An array of key/value pair free form string values.

Sample JSON

Below is a sample JSON representation of the ConfigParamDefDoc structure:

▼ ConfigParamDefDoc Sample JSON

{
  "configDocId": "-",
  "format": "-",
  "frequencies": [
    0
  ],
  "id": "-",
  "identityDocIds": [
    "string-value"
  ],
  "max": 0,
  "min": 0,
  "paramDefDocId": "-",
  "tags": [
    {
      "$type": "TagDoc"
    }
  ],
  "type": {
    "$type": "Fixed String"
  },
  "unitConversion": "-",
  "units": "-"
}