Events integration with types

The basic event model can be extended by defining Event Types using the Type Management service. Event Types are templates for events with definitions for additional properties and relationships.

Enumeration sets

Type Management also supports defining enumeration sets. These can be referenced by both ad hoc and type properties.

Enumeration set example

{

    "Id": "MaintenanceType",

    "Name": "Maintenance Type Enum",

    "Description": "Type of maintenance that needs to be done",

    "State": "Active",

    "BaseTypeId": null,

    "TypeCode": "Int32Enum",

    "Tags": [],

    "Properties": [

        {

            "Id": "Inspection",

            "Name": "Inspection",

            "State": "Active",

            "TypeCode": " Int32",

            "IsRequired": false,

            "Value": 1

        },

        {

            "Id": "Corrective",

            "Name": "Corrective",

            "State": "Active",

            "TypeCode": " Int32",

            "TypeId": null,

            "IsRequired": false,

            "Value": 2

        },

        {

            "Id": "BladeService",

            "Name": "BladeService",

            "State": "Active",

            "TypeCode": "Int32",

            "TypeId": null,

            "IsRequired": false,

            "Value": 3

        }

    ],

    "Relationships": []

}

Event types

All Event Types are defined with BaseEvent as their baseTypeId. The property definitions include the data type, unit of measure, enumeration set information, and a required indicator.

Event Type example

{

    "id": "TurbineMaintenanceEvent",

    "name": "Turbine Maintenance Event",

    "description": "Turbine Maintenance Event Template",

    "baseTypeId": "BaseEvent",

    "state": "Active",

    "typeCode": "Object",

    "properties": [

        {

            "id": "MaintenancePerformedBy",

            "name": "Maintenance Performed By",

            "description": "The name of the person performing the maintenance",

            "isRequired": true,

            "state": "Active",

            "typeCode": "string"

        },

        {

            "id": "MaintenanceType",

            "name": "Maintenance Type",

            "description": "The type of Maintenance.",

            "isRequired": false,

            "state": "Active",

            "typeCode": "Int32Enum",

            "typeId": "MaintenanceType"

        },

        {

            "id": "EstimatedDuration",

            "name": "Estimated Duration",

            "description": "The expected time to complete the maintenance.",

            "isRequired": true,

            "state": "Active",

            "typeCode": "timespan"

        },

        {

            "id": "PowerOutput",

            "name": "Power Output",

            "description": "The power output of the wind turbine.",

            "isRequired": true,

            "state": "Active",

            "typeCode": "Double",

            "uom": "kW"

        }

    ],

    "relationships": [

        {

            "id": "PreviousMaintenanceEvent",

            "name": "Previous Maintenance Event",

            "description": "The maintenance event that occurred prior.",

            "isCollection": false,

            "isRequired": true,

            "state": "Active",

            "targetTypeIds": [

                "BaseEvent"

            ]

        }

    ]

}