2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "$id": "urn:OCPP:Cp:2:2020:3:NotifyReportRequest",
4 "$comment": "OCPP 2.0.1 FINAL",
7 "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.",
8 "javaType": "CustomData",
16 "required": ["vendorId"]
18 "AttributeEnumType": {
19 "description": "Attribute: Actual, MinSet, MaxSet, etc.\r\nDefaults to Actual if absent.\r\n",
20 "javaType": "AttributeEnum",
23 "additionalProperties": false,
24 "enum": ["Actual", "Target", "MinSet", "MaxSet"]
27 "description": "Data type of this variable.\r\n",
28 "javaType": "DataEnum",
30 "additionalProperties": false,
42 "MutabilityEnumType": {
43 "description": "Defines the mutability of this attribute. Default is ReadWrite when omitted.\r\n",
44 "javaType": "MutabilityEnum",
46 "default": "ReadWrite",
47 "additionalProperties": false,
48 "enum": ["ReadOnly", "WriteOnly", "ReadWrite"]
51 "description": "A physical or logical component\r\n",
52 "javaType": "Component",
54 "additionalProperties": false,
57 "$ref": "#/definitions/CustomDataType"
60 "$ref": "#/definitions/EVSEType"
63 "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",
68 "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
76 "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n",
79 "additionalProperties": false,
82 "$ref": "#/definitions/CustomDataType"
85 "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nEVSE Identifier. This contains a number (> 0) designating an EVSE of the Charging Station.\r\n",
89 "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
96 "description": "Class to report components, variables and variable attributes and characteristics.\r\n",
97 "javaType": "ReportData",
99 "additionalProperties": false,
102 "$ref": "#/definitions/CustomDataType"
105 "$ref": "#/definitions/ComponentType"
108 "$ref": "#/definitions/VariableType"
110 "variableAttribute": {
112 "additionalItems": false,
114 "$ref": "#/definitions/VariableAttributeType"
119 "variableCharacteristics": {
120 "$ref": "#/definitions/VariableCharacteristicsType"
123 "required": ["component", "variable", "variableAttribute"]
125 "VariableAttributeType": {
126 "description": "Attribute data of a variable.\r\n",
127 "javaType": "VariableAttribute",
129 "additionalProperties": false,
132 "$ref": "#/definitions/CustomDataType"
135 "$ref": "#/definitions/AttributeEnumType"
138 "description": "Value of the attribute. May only be omitted when mutability is set to 'WriteOnly'.\r\n\r\nThe Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal. \r\n",
143 "$ref": "#/definitions/MutabilityEnumType"
146 "description": "If true, value will be persistent across system reboots or power down. Default when omitted is false.\r\n",
151 "description": "If true, value that will never be changed by the Charging Station at runtime. Default when omitted is false.\r\n",
157 "VariableCharacteristicsType": {
158 "description": "Fixed read-only parameters of a variable.\r\n",
159 "javaType": "VariableCharacteristics",
161 "additionalProperties": false,
164 "$ref": "#/definitions/CustomDataType"
167 "description": "Unit of the variable. When the transmitted value has a unit, this field SHALL be included.\r\n",
172 "$ref": "#/definitions/DataEnumType"
175 "description": "Minimum possible value of this variable.\r\n",
179 "description": "Maximum possible value of this variable. When the datatype of this Variable is String, OptionList, SequenceList or MemberList, this field defines the maximum length of the (CSV) string.\r\n",
183 "description": "Allowed values when variable is Option/Member/SequenceList. \r\n\r\n* OptionList: The (Actual) Variable value must be a single value from the reported (CSV) enumeration list.\r\n\r\n* MemberList: The (Actual) Variable value may be an (unordered) (sub-)set of the reported (CSV) valid values list.\r\n\r\n* SequenceList: The (Actual) Variable value may be an ordered (priority, etc) (sub-)set of the reported (CSV) valid values.\r\n\r\nThis is a comma separated list.\r\n\r\nThe Configuration Variable <<configkey-configuration-value-size,ConfigurationValueSize>> can be used to limit SetVariableData.attributeValue and VariableCharacteristics.valueList. The max size of these values will always remain equal. \r\n\r\n",
187 "supportsMonitoring": {
188 "description": "Flag indicating if this variable supports monitoring. \r\n",
192 "required": ["dataType", "supportsMonitoring"]
195 "description": "Reference key to a component-variable.\r\n",
196 "javaType": "Variable",
198 "additionalProperties": false,
201 "$ref": "#/definitions/CustomDataType"
204 "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",
209 "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
218 "additionalProperties": false,
221 "$ref": "#/definitions/CustomDataType"
224 "description": "The id of the GetReportRequest or GetBaseReportRequest that requested this report\r\n",
228 "description": "Timestamp of the moment this message was generated at the Charging Station.\r\n",
230 "format": "date-time"
234 "additionalItems": false,
236 "$ref": "#/definitions/ReportDataType"
241 "description": "“to be continued” indicator. Indicates whether another part of the report follows in an upcoming notifyReportRequest message. Default value when omitted is false.\r\n\r\n",
246 "description": "Sequence number of this message. First message starts at 0.\r\n",
250 "required": ["requestId", "generatedAt", "seqNo"]