@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
147 lines (146 loc) • 5.85 kB
JSON
{
"$id": "GetMonitoringReportRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"MonitoringCriterionEnumType": {
"javaType": "MonitoringCriterionEnum",
"type": "string",
"additionalProperties": false,
"enum": ["ThresholdMonitoring", "DeltaMonitoring", "PeriodicMonitoring"],
"tsEnumNames": ["ThresholdMonitoring", "DeltaMonitoring", "PeriodicMonitoring"]
},
"ComponentType": {
"description": "A physical or logical component\r\n",
"javaType": "Component",
"type": "object",
"additionalProperties": false,
"properties": {
"evse": {
"$ref": "#/definitions/EVSEType"
},
"name": {
"description": "Name of the component. Name should be taken from the list of standardized component names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
"type": "string",
"maxLength": 50
},
"instance": {
"description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
"type": "string",
"maxLength": 50
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["name"]
},
"ComponentVariableType": {
"description": "Class to report components, variables and variable attributes and characteristics.\r\n",
"javaType": "ComponentVariable",
"type": "object",
"additionalProperties": false,
"properties": {
"component": {
"$ref": "#/definitions/ComponentType"
},
"variable": {
"$ref": "#/definitions/VariableType"
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["component"]
},
"EVSEType": {
"description": "Electric Vehicle Supply Equipment\r\n",
"javaType": "EVSE",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "EVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.\r\n",
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"connectorId": {
"description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["id"]
},
"VariableType": {
"description": "Reference key to a component-variable.\r\n",
"javaType": "Variable",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"description": "Name of the variable. Name should be taken from the list of standardized variable names whenever possible. Case Insensitive. strongly advised to use Camel Case.\r\n",
"type": "string",
"maxLength": 50
},
"instance": {
"description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
"type": "string",
"maxLength": 50
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["name"]
},
"CustomDataType": {
"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"componentVariable": {
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/definitions/ComponentVariableType"
},
"minItems": 1
},
"requestId": {
"description": "The Id of the request.\r\n",
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
},
"monitoringCriteria": {
"description": "This field contains criteria for components for which a monitoring report is requested\r\n",
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/definitions/MonitoringCriterionEnumType"
},
"minItems": 1,
"maxItems": 3
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["requestId"]
}