Datamodel Basic Types

Type: address

Table 1. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "apn": {
            "title": "APN",
            "type": "string"
        },
        "type": {
            "enum": [
                "IPV4",
                "IPV6",
                "MAC48",
                "UNKNOWN",
                "SIGFOX",
                "HOSTNAME"
            ],
            "javaEnumNames": [
                "IPV4",
                "IPV6",
                "MAC48",
                "UNKNOWN",
                "SIGFOX",
                "HOSTNAME"
            ],
            "title": "Type",
            "type": "string"
        },
        "value": {
            "description": "value of the parameter",
            "title": "Value",
            "type": "string"
        }
    },
    "public": true,
    "type": "object"
}

Type: administrativeState

Table 2. Attributes
Attribute	Value
type	string
description
values	ACTIVE BANNED DELETED INVALID READY REPAIR REQUESTED RETIRED SUSPENDED TESTED TESTING UNKNOWN

Type in JSON format

{
    "description": "",
    "enum": [
        "ACTIVE",
        "BANNED",
        "DELETED",
        "INVALID",
        "READY",
        "REPAIR",
        "REQUESTED",
        "RETIRED",
        "SUSPENDED",
        "TESTED",
        "TESTING",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "ACTIVE",
        "BANNED",
        "DELETED",
        "INVALID",
        "READY",
        "REPAIR",
        "REQUESTED",
        "RETIRED",
        "SUSPENDED",
        "TESTED",
        "TESTING",
        "UNKNOWN"
    ],
    "title": "Administrative State",
    "type": "string"
}

Type: antennaStatus

Table 3. Attributes
Attribute	Value
type	string
description
values	NORMAL OPEN SHORT_CIRCUIT UNKNOWN

Type in JSON format

{
    "enum": [
        "NORMAL",
        "OPEN",
        "SHORT_CIRCUIT",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "NORMAL",
        "OPEN",
        "SHORT_CIRCUIT",
        "UNKNOWN"
    ],
    "type": "string"
}

Type: area

Table 4. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "description": {
            "type": "string"
        },
        "identifier": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "order": {
            "type": "integer"
        }
    },
    "type": "object"
}

Type: areas

Table 5. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "$ref": "#/definitions/area"
    },
    "type": "array"
}

Type: arrayIdentifier

Table 6. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "$ref": "#/definitions/ogIdentifier"
    },
    "type": "array"
}

Type: arrayString

Table 7. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "type": "string"
    },
    "type": "array"
}

Type: assetAdministrativeState

Table 8. Attributes
Attribute	Value
type	string
description
values	BANNED DELETED IN_MAINTENANCE IN_STOCK IN_TRANSIT IN_USE MISSING ORDERED READY RETIRED

Type in JSON format

{
    "description": "",
    "enum": [
        "BANNED",
        "DELETED",
        "IN_MAINTENANCE",
        "IN_STOCK",
        "IN_TRANSIT",
        "IN_USE",
        "MISSING",
        "ORDERED",
        "READY",
        "RETIRED"
    ],
    "javaEnumNames": [
        "BANNED",
        "DELETED",
        "IN_MAINTENANCE",
        "IN_STOCK",
        "IN_TRANSIT",
        "IN_USE",
        "MISSING",
        "ORDERED",
        "READY",
        "RETIRED"
    ],
    "title": "Asset Administrative State",
    "type": "string"
}

Type: assetSpecificType

Table 9. Attributes
Attribute	Value
type	string
description
values	BOX BUILDING CONTROL_HOUSE CRANE FOUNTAIN ENGINE HOUSE MACHINE OTHER PALLET PIPELINE SPOOL TOWER VEHICLE WIRE WORKER SUPPLY_POINT CONTRACTOR ORGANIZATION OPERATOR CHANNEL ZONE PROVINCE BTS POSTAL_CODE

Type in JSON format

{
    "enum": [
        "BOX",
        "BUILDING",
        "CONTROL_HOUSE",
        "CRANE",
        "FOUNTAIN",
        "ENGINE",
        "HOUSE",
        "MACHINE",
        "OTHER",
        "PALLET",
        "PIPELINE",
        "SPOOL",
        "TOWER",
        "VEHICLE",
        "WIRE",
        "WORKER",
        "SUPPLY_POINT",
        "CONTRACTOR",
        "ORGANIZATION",
        "OPERATOR",
        "CHANNEL",
        "ZONE",
        "PROVINCE",
        "BTS",
        "POSTAL_CODE"
    ],
    "javaEnumNames": [
        "BOX",
        "BUILDING",
        "CONTROL_HOUSE",
        "CRANE",
        "FOUNTAIN",
        "ENGINE",
        "HOUSE",
        "MACHINE",
        "OTHER",
        "PALLET",
        "PIPELINE",
        "SPOOL",
        "TOWER",
        "VEHICLE",
        "WIRE",
        "WORKER",
        "SUPPLY_POINT",
        "CONTRACTOR",
        "ORGANIZATION",
        "OPERATOR",
        "CHANNEL",
        "ZONE",
        "PROVINCE",
        "BTS",
        "POSTAL_CODE"
    ],
    "type": "string"
}

Type: batteryStatus

Table 10. Attributes
Attribute	Value
type	string
description
values	CHARGING CHARGED UNPLUGGED ERROR UNKNOWN

Type in JSON format

{
    "enum": [
        "CHARGING",
        "CHARGED",
        "UNPLUGGED",
        "ERROR",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "CHARGING",
        "CHARGED",
        "UNPLUGGED",
        "ERROR",
        "UNKNOWN"
    ],
    "type": "string"
}

Type: certificateList

Table 11. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "type": "string"
    },
    "type": "array"
}

Type: clock

Table 12. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "description": "",
    "properties": {
        "datetime": {
            "$ref": "#/definitions/timestamp"
        },
        "dst": {
            "properties": {
                "begin": {
                    "$ref": "#/definitions/timestamp"
                },
                "deviation": {
                    "type": "number"
                },
                "enabled": {
                    "type": "boolean"
                },
                "end": {
                    "$ref": "#/definitions/timestamp"
                }
            },
            "type": "object"
        },
        "timezone": {
            "type": "number"
        }
    },
    "public": true,
    "title": "Clock",
    "type": "object"
}

Type: commsModuleOperationalStatus

Table 13. Attributes
Attribute	Value
type	string
description
values	STOPPED STOPPING STARTING RUNNING DISABLED ERROR

Type in JSON format

{
    "description": "",
    "enum": [
        "STOPPED",
        "STOPPING",
        "STARTING",
        "RUNNING",
        "DISABLED",
        "ERROR"
    ],
    "javaEnumNames": [
        "STOPPED",
        "STOPPING",
        "STARTING",
        "RUNNING",
        "DISABLED",
        "ERROR"
    ],
    "title": "Operational Status",
    "type": "string"
}

Type: commsModuleSpecificType

Table 14. Attributes
Attribute	Value
type	string
description
values	ADSL CAN ETH GENERIC GSM HAN I2C LOWPAN MESH MOBILE MULTIMOBILE PLC RS232 RS422 RS485 SIGFOX UMTS WIFI ZIGBEE ZWAVE NARROWBAND LTE_M

Type in JSON format

{
    "enum": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "MULTIMOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIGFOX",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "javaEnumNames": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "MULTIMOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIGFOX",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "type": "string"
}

Type: coordinates

Table 15. Attributes
Attribute	Value
type	array
description	A geographical coordinates

Type in JSON format

{
    "description": "A geographical coordinates",
    "items": {
        "type": "number"
    },
    "maxItems": 2,
    "public": true,
    "type": "array"
}

Type: cpuStatus

Table 16. Attributes
Attribute	Value
type	string
description
values	IDLE IDLE/WORKING WORKING STRESSED OVERLOAD

Type in JSON format

{
    "enum": [
        "IDLE",
        "IDLE/WORKING",
        "WORKING",
        "STRESSED",
        "OVERLOAD"
    ],
    "javaEnumNames": [
        "IDLE",
        "IDLE_WORKING",
        "WORKING",
        "STRESSED",
        "OVERLOAD"
    ],
    "type": "string"
}

Type: datamodelParamName

Table 17. Attributes
Attribute	Value
type	string
description	Id of the parameter

Type in JSON format

{
    "description": "Id of the parameter",
    "title": "Id",
    "type": "string"
}

Type: datamodelParamNameValue

Table 18. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "name": {
            "$ref": "#/definitions/datamodelParamName"
        },
        "value": {
            "description": "Value of the parameter",
            "title": "Value",
            "type": "string"
        }
    },
    "required": [
        "name",
        "value"
    ],
    "type": "object"
}

Type: datamodelResponse

Table 19. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "name": {
            "description": "Id of the parameter",
            "title": "Id",
            "type": "string"
        },
        "resultCode": {
            "$ref": "#/definitions/datamodelResultCode"
        },
        "resultDescription": {
            "description": "Result description of Get Operation",
            "title": "Result Description",
            "type": "string"
        },
        "value": {
            "description": "value of the parameter",
            "title": "type",
            "type": "string"
        }
    },
    "required": [
        "name",
        "value"
    ],
    "type": "object"
}

Type: datamodelResultCode

Table 20. Attributes
Attribute	Value
type	string
description	Result code of Get Operation
values	SUCCESS PARAM_NOT_SUPPORTED INVALID_FORMAT WRONG_VALUE UNKNOWN

Type in JSON format

{
    "description": "Result code of Get Operation",
    "enum": [
        "SUCCESS",
        "PARAM_NOT_SUPPORTED",
        "INVALID_FORMAT",
        "WRONG_VALUE",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "SUCCESS",
        "PARAM_NOT_SUPPORTED",
        "INVALID_FORMAT",
        "WRONG_VALUE",
        "UNKNOWN"
    ],
    "title": "Result Code",
    "type": "string"
}

Type: date

Table 21. Attributes
Attribute	Value
type	string
description	date in ISO 8601

Type in JSON format

{
    "description": "date in ISO 8601",
    "format": "date",
    "pattern": "^([0-9]{4})-?(1[0-2]|0[1-9])-?(3[01]|0[1-9]|[12][0-9])$",
    "public": true,
    "title": "date",
    "type": "string"
}

Type: datetime

Table 22. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "date": {
            "$ref": "#/definitions/date"
        },
        "dst": {
            "$ref": "#/definitions/dst"
        },
        "time": {
            "description": "time in ISO 8601",
            "format": "time",
            "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])$",
            "title": "time",
            "type": "string"
        },
        "timezone": {
            "$ref": "#/definitions/timezone"
        }
    },
    "required": [
        "date",
        "time",
        "timezone",
        "dst"
    ],
    "type": "object"
}

Type: deviceOperationalStatus

Table 23. Attributes
Attribute	Value
type	string
description
values	NORMAL SAFE_MODE TAMPER TEST DOWN ALARM UNKNOWN

Type in JSON format

{
    "description": "",
    "enum": [
        "NORMAL",
        "SAFE_MODE",
        "TAMPER",
        "TEST",
        "DOWN",
        "ALARM",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "NORMAL",
        "SAFE_MODE",
        "TAMPER",
        "TEST",
        "DOWN",
        "ALARM",
        "UNKNOWN"
    ],
    "title": "Operational Status",
    "type": "string"
}

Type: deviceSpecificType

Table 24. Attributes
Attribute	Value
type	string
description
values	BLOODPRESSURE_SENSOR COMHUB CONCENTRATOR CONTAINER COORDINATOR GATEWAY GENERIC GLUCOMETER_SENSOR METER MODEM ROUTER SENSOR TPV VEHICLE VENDING WEIGHT_SENSOR

Type in JSON format

{
    "enum": [
        "BLOODPRESSURE_SENSOR",
        "COMHUB",
        "CONCENTRATOR",
        "CONTAINER",
        "COORDINATOR",
        "GATEWAY",
        "GENERIC",
        "GLUCOMETER_SENSOR",
        "METER",
        "MODEM",
        "ROUTER",
        "SENSOR",
        "TPV",
        "VEHICLE",
        "VENDING",
        "WEIGHT_SENSOR"
    ],
    "javaEnumNames": [
        "BLOODPRESSURE_SENSOR",
        "COMHUB",
        "CONCENTRATOR",
        "CONTAINER",
        "COORDINATOR",
        "GATEWAY",
        "GENERIC",
        "GLUCOMETER_SENSOR",
        "METER",
        "MODEM",
        "ROUTER",
        "SENSOR",
        "TPV",
        "VEHICLE",
        "VENDING",
        "WEIGHT_SENSOR"
    ],
    "type": "string"
}

Type: dst

Table 25. Attributes
Attribute	Value
type	integer
description

Type in JSON format

{
    "default": 0,
    "minimum": 0,
    "title": "DST",
    "type": "integer"
}

Type: entityType

Table 26. Attributes
Attribute	Value
type	string
description
values	GATEWAY ASSET COMMUNICATIONS_MODULE SUBSCRIPTION SUBSCRIBER

Type in JSON format

{
    "description": "",
    "enum": [
        "GATEWAY",
        "ASSET",
        "COMMUNICATIONS_MODULE",
        "SUBSCRIPTION",
        "SUBSCRIBER"
    ],
    "javaEnumNames": [
        "GATEWAY",
        "ASSET",
        "COMMUNICATIONS_MODULE",
        "SUBSCRIPTION",
        "SUBSCRIBER"
    ],
    "title": "Entity Type",
    "type": "string"
}

Type: ipStatus

Table 27. Attributes
Attribute	Value
type	string
description
values	OK NOK

Type in JSON format

{
    "description": "",
    "enum": [
        "OK",
        "NOK"
    ],
    "javaEnumNames": [
        "OK",
        "NOK"
    ],
    "title": "IP Reachability Status",
    "type": "string"
}

Type: ipv4

Table 28. Attributes
Attribute	Value
type	string
description	IPV4 format

Type in JSON format

{
    "description": "IPV4 format",
    "format": "ipv4",
    "pattern": "((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])",
    "public": true,
    "title": "ipv4",
    "type": "string"
}

Type: ipv6

Table 29. Attributes
Attribute	Value
type	string
description	IPV6 format

Type in JSON format

{
    "description": "IPV6 format",
    "format": "ipv6",
    "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))",
    "public": true,
    "title": "ipv6",
    "type": "string"
}

Type: location

Table 30. Attributes
Attribute	Value
type	object
description	A geojson enriched for OpenGate

Type in JSON format

{
    "description": "A geojson enriched for OpenGate",
    "properties": {
        "accuracy": {
            "description": "position accuracy in meters",
            "type": "number"
        },
        "address": {
            "type": "string"
        },
        "country": {
            "type": "string"
        },
        "position": {
            "description": "compatible with geojson format",
            "properties": {
                "coordinates": {
                    "additionalItems": false,
                    "description": "Format [longitude, latitude]",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 2,
                    "type": "array"
                },
                "type": {
                    "default": "Point",
                    "type": "string"
                }
            },
            "required": [
                "coordinates"
            ],
            "type": "object"
        },
        "postal": {
            "type": "string"
        },
        "province": {
            "type": "string"
        },
        "region": {
            "type": "string"
        },
        "source": {
            "enum": [
                "MOBILE",
                "GPS",
                "GLONASS",
                "RTK",
                "RFID",
                "WIFI",
                "ZIGBEE",
                "LORA",
                "SIGFOX-BASIC",
                "SIGFOX-SPOTIT",
                "UNKNOWN"
            ],
            "javaEnumNames": [
                "MOBILE",
                "GPS",
                "GLONASS",
                "RTK",
                "RFID",
                "WIFI",
                "ZIGBEE",
                "LORA",
                "SIGFOX_BASIC",
                "SIGFOX_SPOTIT",
                "UNKNOWN"
            ],
            "type": "string"
        },
        "town": {
            "type": "string"
        },
        "zoom": {
            "description": "zoom for the web map",
            "type": "number"
        }
    },
    "public": true,
    "type": "object"
}

Type: mac48

Table 31. Attributes
Attribute	Value
type	string
description	MAC48 format

Type in JSON format

{
    "description": "MAC48 format",
    "pattern": "(([0-9A-Fa-f]{2}[-:]){5}[0-9A-Fa-f]{2})|(([0-9A-Fa-f]{4}){2}[0-9A-Fa-f]{4})",
    "public": true,
    "title": "mac48",
    "type": "string"
}

Type: model

Table 32. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "description": "",
    "properties": {
        "manufacturer": {
            "type": "string"
        },
        "manufacturerOUI": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "version": {
            "type": "string"
        }
    },
    "public": true,
    "title": "Model",
    "type": "object"
}

Type: msisdn

Table 33. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "maxLength": 15,
    "minLength": 7,
    "public": true,
    "type": "string"
}

Type: ogIdentifier

Table 34. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "pattern": "^[a-zA-Z0-9_@.-]*$",
    "public": true,
    "type": "string"
}

Type: ogIdentifierUnreferenced

Table 35. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "pattern": "^[a-zA-Z0-9_@.-]*$",
    "public": true,
    "type": "string"
}

Type: ogImage

Table 36. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "type": "string"
}

Type: outage

Table 37. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "duration": {
            "type": "number"
        },
        "started": {
            "$ref": "#/definitions/timestamp"
        }
    },
    "type": "object"
}

Type: percentage

Table 38. Attributes
Attribute	Value
type	number
description

Type in JSON format

{
    "maximum": 100,
    "minimum": 0,
    "public": true,
    "type": "number"
}

Type: powerSupplySource

Table 39. Attributes
Attribute	Value
type	string
description
values	BATTERY DIESEL_GENERATOR NETWORK_PLUGGED SOLAR OTHER

Type in JSON format

{
    "enum": [
        "BATTERY",
        "DIESEL_GENERATOR",
        "NETWORK_PLUGGED",
        "SOLAR",
        "OTHER"
    ],
    "javaEnumNames": [
        "BATTERY",
        "DIESEL_GENERATOR",
        "NETWORK_PLUGGED",
        "SOLAR",
        "OTHER"
    ],
    "type": "string"
}

Type: powerSupplyStatus

Table 40. Attributes
Attribute	Value
type	string
description
values	PLUGGED_CHARGING PLUGGED_CHARGED OUTAGE UNPLUGGED UNKNOWN

Type in JSON format

{
    "enum": [
        "PLUGGED_CHARGING",
        "PLUGGED_CHARGED",
        "OUTAGE",
        "UNPLUGGED",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "PLUGGED_CHARGING",
        "PLUGGED_CHARGED",
        "OUTAGE",
        "UNPLUGGED",
        "UNKNOWN"
    ],
    "type": "string"
}

Type: presenceGprs

Table 41. Attributes
Attribute	Value
type	string
description
values	START STOP INTERIM_UPDATE ON OFF NOK

Type in JSON format

{
    "enum": [
        "START",
        "STOP",
        "INTERIM_UPDATE",
        "ON",
        "OFF",
        "NOK"
    ],
    "javaEnumNames": [
        "START",
        "STOP",
        "INTERIM_UPDATE",
        "ON",
        "OFF",
        "NOK"
    ],
    "type": "string"
}

Type: presenceGsm

Table 42. Attributes
Attribute	Value
type	string
description
values	OK NOK UNCONFIG UNKNOWN

Type in JSON format

{
    "enum": [
        "OK",
        "NOK",
        "UNCONFIG",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "OK",
        "NOK",
        "UNCONFIG",
        "UNKNOWN"
    ],
    "type": "string"
}

Type: presenceIp

Table 43. Attributes
Attribute	Value
type	string
description
values	OK NOK

Type in JSON format

{
    "enum": [
        "OK",
        "NOK"
    ],
    "javaEnumNames": [
        "OK",
        "NOK"
    ],
    "type": "string"
}

Type: signalQualityStatus

Table 44. Attributes
Attribute	Value
type	string
description
values	LOW_CRITICAL LOW_WARNING NORMAL EXCELENT

Type in JSON format

{
    "enum": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "EXCELENT"
    ],
    "javaEnumNames": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "EXCELENT"
    ],
    "type": "string"
}

Type: signalStrengthStatus

Table 45. Attributes
Attribute	Value
type	string
description
values	LOW_CRITICAL LOW_WARNING NORMAL EXCELENT

Type in JSON format

{
    "enum": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "EXCELENT"
    ],
    "javaEnumNames": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "EXCELENT"
    ],
    "type": "string"
}

Type: software

Table 46. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "description": "",
    "properties": {
        "name": {
            "type": "string"
        },
        "type": {
            "enum": [
                "SOFTWARE",
                "FIRMWARE"
            ],
            "javaEnumNames": [
                "SOFTWARE",
                "FIRMWARE"
            ],
            "type": "string"
        },
        "version": {
            "type": "string"
        }
    },
    "public": true,
    "title": "Software",
    "type": "object"
}

Type: softwareList

Table 47. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "$ref": "#/definitions/software"
    },
    "type": "array"
}

Type: subscriberSpecificType

Table 48. Attributes
Attribute	Value
type	string
description
values	ADSL CAN ETH GENERIC GSM HAN I2C LOWPAN MESH MOBILE PLC RS232 RS422 RS485 SIM UMTS WIFI ZIGBEE ZWAVE NARROWBAND LTE_M

Type in JSON format

{
    "enum": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIM",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "javaEnumNames": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIM",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "type": "string"
}

Type: subscriptionSpecificType

Table 49. Attributes
Attribute	Value
type	string
description
values	ADSL CAN ETH GENERIC GSM HAN I2C LOWPAN MESH MOBILE PLC RS232 RS422 RS485 SIGFOX UMTS WIFI ZIGBEE ZWAVE NARROWBAND LTE_M

Type in JSON format

{
    "enum": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIGFOX",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "javaEnumNames": [
        "ADSL",
        "CAN",
        "ETH",
        "GENERIC",
        "GSM",
        "HAN",
        "I2C",
        "LOWPAN",
        "MESH",
        "MOBILE",
        "PLC",
        "RS232",
        "RS422",
        "RS485",
        "SIGFOX",
        "UMTS",
        "WIFI",
        "ZIGBEE",
        "ZWAVE",
        "NARROWBAND",
        "LTE_M"
    ],
    "type": "string"
}

Type: temperatureStatus

Table 50. Attributes
Attribute	Value
type	string
description
values	LOW_CRITICAL LOW_WARNING NORMAL HIGH_WARNING HIGH_CRITICAL

Type in JSON format

{
    "enum": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "HIGH_WARNING",
        "HIGH_CRITICAL"
    ],
    "javaEnumNames": [
        "LOW_CRITICAL",
        "LOW_WARNING",
        "NORMAL",
        "HIGH_WARNING",
        "HIGH_CRITICAL"
    ],
    "type": "string"
}

Type: text

Table 51. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "type": "string"
}

Type: ticketIdentifier

Table 52. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "pattern": "^[a-zA-Z0-9_@.-]*$",
    "public": true,
    "type": "string"
}

Type: ticketPriority

Table 53. Attributes
Attribute	Value
type	string
description
values	MAJOR MINOR CRITICAL BLOCKER

Type in JSON format

{
    "enum": [
        "MAJOR",
        "MINOR",
        "CRITICAL",
        "BLOCKER"
    ],
    "javaEnumNames": [
        "MAJOR",
        "MINOR",
        "CRITICAL",
        "BLOCKER"
    ],
    "title": "Priority",
    "type": "string"
}

Type: ticketSeverity

Table 54. Attributes
Attribute	Value
type	string
description
values	CRITICAL URGENT WARNING NORMAL

Type in JSON format

{
    "enum": [
        "CRITICAL",
        "URGENT",
        "WARNING",
        "NORMAL"
    ],
    "javaEnumNames": [
        "CRITICAL",
        "URGENT",
        "WARNING",
        "NORMAL"
    ],
    "title": "Severity",
    "type": "string"
}

Type: ticketSpecificType

Table 55. Attributes
Attribute	Value
type	string
description
values	WORKORDER INCIDENT REQUEST FORM

Type in JSON format

{
    "enum": [
        "WORKORDER",
        "INCIDENT",
        "REQUEST",
        "FORM"
    ],
    "javaEnumNames": [
        "WORKORDER",
        "INCIDENT",
        "REQUEST",
        "FORM"
    ],
    "title": "Specific Type",
    "type": "string"
}

Type: ticketStatus

Table 56. Attributes
Attribute	Value
type	string
description
values	CREATED ASSIGNED ANSWERED RESTORED RESOLVED CLOSED

Type in JSON format

{
    "enum": [
        "CREATED",
        "ASSIGNED",
        "ANSWERED",
        "RESTORED",
        "RESOLVED",
        "CLOSED"
    ],
    "javaEnumNames": [
        "CREATED",
        "ASSIGNED",
        "ANSWERED",
        "RESTORED",
        "RESOLVED",
        "CLOSED"
    ],
    "title": "Status",
    "type": "string"
}

Type: ticketType

Table 57. Attributes
Attribute	Value
type	string
description
values	INSTALLATION TEST TECHNICAL_TASK UNINSTALLATION MODIFICATION BALANCES_AT_MT_TELEMEDIDA

Type in JSON format

{
    "enum": [
        "INSTALLATION",
        "TEST",
        "TECHNICAL_TASK",
        "UNINSTALLATION",
        "MODIFICATION",
        "BALANCES_AT_MT_TELEMEDIDA"
    ],
    "javaEnumNames": [
        "INSTALLATION",
        "TEST",
        "TECHNICAL_TASK",
        "UNINSTALLATION",
        "MODIFICATION",
        "BALANCES_AT_MT_TELEMEDIDA"
    ],
    "title": "Type",
    "type": "string"
}

Type: time

Table 58. Attributes
Attribute	Value
type	string
description	time in ISO 8601

Type in JSON format

{
    "description": "time in ISO 8601",
    "format": "time",
    "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])(\\.([0-9]{3}))?([Z]|(\\+|-)(2[0-3]|[01][0-9]):?([0-5][0-9]))$",
    "public": true,
    "title": "time",
    "type": "string"
}

Type: timestamp

Table 59. Attributes
Attribute	Value
type	string
description	date & time in ISO 8601

Type in JSON format

{
    "description": "date & time in ISO 8601",
    "format": "date-time",
    "pattern": "^([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):?([0-5][0-9]):?([0-5][0-9])(\\.([0-9]{1,3}))?([Z]|(\\+|-)(2[0-3]|[01][0-9]):?([0-5][0-9]))$",
    "public": true,
    "title": "timestamp",
    "type": "string"
}

Type: timezone

Table 60. Attributes
Attribute	Value
type	string
description

Type in JSON format

{
    "title": "timezone",
    "type": "string"
}

Type: topologyPath

Table 61. Attributes
Attribute	Value
type	array
description

Type in JSON format

{
    "items": {
        "type": "string"
    },
    "type": "array"
}

Type: trafficSession

Table 62. Attributes
Attribute	Value
type	object
description

Type in JSON format

{
    "properties": {
        "address": {
            "$ref": "#/definitions/address"
        },
        "duration": {
            "type": "number"
        },
        "id": {
            "type": "string"
        },
        "nasIp": {
            "$ref": "#/definitions/address"
        },
        "radiusClientIp": {
            "$ref": "#/definitions/address"
        },
        "receivedBytes": {
            "type": "number"
        },
        "receivedPackets": {
            "type": "number"
        },
        "sentBytes": {
            "type": "number"
        },
        "sentPackets": {
            "type": "number"
        },
        "status": {
            "enum": [
                "TERMINATED",
                "IN_PROGRESS",
                "UNKNOWN"
            ],
            "javaEnumNames": [
                "TERMINATED",
                "IN_PROGRESS",
                "UNKNOWN"
            ],
            "type": "string"
        },
        "terminateCause": {
            "type": "string"
        }
    },
    "public": true,
    "type": "object"
}

Type: unifiedPresence

Table 63. Attributes
Attribute	Value
type	string
description
values	IP GPRS GSM NOT_REGISTERED UNKNOWN

Type in JSON format

{
    "enum": [
        "IP",
        "GPRS",
        "GSM",
        "NOT_REGISTERED",
        "UNKNOWN"
    ],
    "javaEnumNames": [
        "IP",
        "GPRS",
        "GSM",
        "NOT_REGISTERED",
        "UNKNOWN"
    ],
    "type": "string"
}