Regno Standard - EventDefDoc 


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 - Regno unique document identifier.
type Fixed String No EventDefDoc Type of the document, resolved from fixed document types.
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 No UnKnown A fixed string value describing the priority of the event. Valid options are: High, Medium, Low, Debug. Valid Options are: UnKnown, High, Low, Medium, Debug
name String No - A free form string value to name the conversion.
description String No - A free form string description of the event.
eventType Fixed String No Event A fixed string value describing the type of the event being logged. Valid options are: Event, Error, Annotation, Alert Valid Options are: Event, Error, Annotation, Alert

Sample JSON

Below is a sample JSON representation of the EventDefDoc structure:

▼ EventDefDoc Sample JSON 
{
  "description": "-",
  "eventType": {
    "$type": "Fixed String"
  },
  "group": "-",
  "id": "-",
  "name": "-",
  "priority": {
    "$type": "Fixed String"
  },
  "sourceId": "-",
  "type": {
    "$type": "Fixed String"
  }
}