src/assets/json-schemas/ocpp/2.0/GetReportRequest.json

   1 {
   2   "$schema": "http://json-schema.org/draft-06/schema#",
   3   "$id": "urn:OCPP:Cp:2:2020:3:GetReportRequest",
   4   "comment": "OCPP 2.0.1 FINAL",
   5   "definitions": {
   6     "CustomDataType": {
   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",
   9       "type": "object",
  10       "properties": {
  11         "vendorId": {
  12           "type": "string",
  13           "maxLength": 255
  14         }
  15       },
  16       "required": ["vendorId"]
  17     },
  18     "ComponentCriterionEnumType": {
  19       "javaType": "ComponentCriterionEnum",
  20       "type": "string",
  21       "additionalProperties": false,
  22       "enum": ["Active", "Available", "Enabled", "Problem"]
  23     },
  24     "ComponentType": {
  25       "description": "A physical or logical component\r\n",
  26       "javaType": "Component",
  27       "type": "object",
  28       "additionalProperties": false,
  29       "properties": {
  30         "customData": {
  31           "$ref": "#/definitions/CustomDataType"
  32         },
  33         "evse": {
  34           "$ref": "#/definitions/EVSEType"
  35         },
  36         "name": {
  37           "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",
  38           "type": "string",
  39           "maxLength": 50
  40         },
  41         "instance": {
  42           "description": "Name of instance in case the component exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
  43           "type": "string",
  44           "maxLength": 50
  45         }
  46       },
  47       "required": ["name"]
  48     },
  49     "ComponentVariableType": {
  50       "description": "Class to report components, variables and variable attributes and characteristics.\r\n",
  51       "javaType": "ComponentVariable",
  52       "type": "object",
  53       "additionalProperties": false,
  54       "properties": {
  55         "customData": {
  56           "$ref": "#/definitions/CustomDataType"
  57         },
  58         "component": {
  59           "$ref": "#/definitions/ComponentType"
  60         },
  61         "variable": {
  62           "$ref": "#/definitions/VariableType"
  63         }
  64       },
  65       "required": ["component"]
  66     },
  67     "EVSEType": {
  68       "description": "EVSE\r\nurn:x-oca:ocpp:uid:2:233123\r\nElectric Vehicle Supply Equipment\r\n",
  69       "javaType": "EVSE",
  70       "type": "object",
  71       "additionalProperties": false,
  72       "properties": {
  73         "customData": {
  74           "$ref": "#/definitions/CustomDataType"
  75         },
  76         "id": {
  77           "description": "Identified_ Object. MRID. Numeric_ Identifier\r\nurn:x-enexis:ecdm:uid:1:569198\r\nEVSE Identifier. This contains a number (&gt; 0) designating an EVSE of the Charging Station.\r\n",
  78           "type": "integer"
  79         },
  80         "connectorId": {
  81           "description": "An id to designate a specific connector (on an EVSE) by connector index number.\r\n",
  82           "type": "integer"
  83         }
  84       },
  85       "required": ["id"]
  86     },
  87     "VariableType": {
  88       "description": "Reference key to a component-variable.\r\n",
  89       "javaType": "Variable",
  90       "type": "object",
  91       "additionalProperties": false,
  92       "properties": {
  93         "customData": {
  94           "$ref": "#/definitions/CustomDataType"
  95         },
  96         "name": {
  97           "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",
  98           "type": "string",
  99           "maxLength": 50
 100         },
 101         "instance": {
 102           "description": "Name of instance in case the variable exists as multiple instances. Case Insensitive. strongly advised to use Camel Case.\r\n",
 103           "type": "string",
 104           "maxLength": 50
 105         }
 106       },
 107       "required": ["name"]
 108     }
 109   },
 110   "type": "object",
 111   "additionalProperties": false,
 112   "properties": {
 113     "customData": {
 114       "$ref": "#/definitions/CustomDataType"
 115     },
 116     "componentVariable": {
 117       "type": "array",
 118       "additionalItems": false,
 119       "items": {
 120         "$ref": "#/definitions/ComponentVariableType"
 121       },
 122       "minItems": 1
 123     },
 124     "requestId": {
 125       "description": "The Id of the request.\r\n",
 126       "type": "integer"
 127     },
 128     "componentCriteria": {
 129       "description": "This field contains criteria for components for which a report is requested\r\n",
 130       "type": "array",
 131       "additionalItems": false,
 132       "items": {
 133         "$ref": "#/definitions/ComponentCriterionEnumType"
 134       },
 135       "minItems": 1,
 136       "maxItems": 4
 137     }
 138   },
 139   "required": ["requestId"]
 140 }