Definition - EventDefDoc
The EventDefinitionDoc document
is a definition document that contains the properties for a unique event definition instance.
The EventDefinitionDoc document
is referenced by the EventDataDoc document and
is used to convert event data values into display values.
The EventDefinitionDoc document does not contain a reference to
the ConfigDoc document and therefore can be reused by multiple configurations and data sets.
| Field | Data Type | Required | Default | Description |
|---|---|---|---|---|
| id | String | Yes | - | A unique identifier that is referenced by all other documents see section Unique Id Generation. |
| sourceId | String | Yes | - | A free form string identifier for the event. |
| group | String | No | - | A free form string value to associate a group with the event. |
| priority | Fixed String | Yes | High |
A fixed string value describing the priority of the event.
Valid options are: High, Medium, Low, Debug, Unknown. |
| name | String | No | - | A free form string value to name the event. |
| description | String | No | - | A free form string description of the event. |
| conversions | Array [ConversionDefDoc] | No | - | An array of the ConversionDefDoc used to convert the event raw data values into a display value. Multiple types of conversion documents exist. |
| type | Fixed String | Fixed | EventDefDoc | The fixed value is always set to EventDefDoc. |