Group

Type: object

nan

 No Additional Properties

root GeographicalRegion
Type: object

Hash table of GeographicalRegion objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root GeographicalRegion GeographicalRegion.json
Type: object

A geographical region of a power system network model.

 No Additional Properties

root GeographicalRegion GeographicalRegion GeographicalRegion.Regions
Type: array of string

Pointers to SubGeographicalRegion objects

 No Additional Items

Each item of this array must be:

root GeographicalRegion GeographicalRegion GeographicalRegion.Regions SubGeographicalRegionPointer
Type: string

Pointer to SubGeographicalRegion object

root GeographicalRegion GeographicalRegion Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root GeographicalRegion GeographicalRegion IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root GeographicalRegion GeographicalRegion IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root GeographicalRegion GeographicalRegion IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root GeographicalRegion GeographicalRegion IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root SubGeographicalRegion
Type: object

Hash table of SubGeographicalRegion objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root SubGeographicalRegion SubGeographicalRegion.json
Type: object

A subset of a geographical region of a power system network model.

 No Additional Properties

root SubGeographicalRegion SubGeographicalRegion SubGeographicalRegion.Region
Type: string

Pointer to GeographicalRegion object

root SubGeographicalRegion SubGeographicalRegion SubGeographicalRegion.EconomicProperty
Type: string

Pointer to EconomicProperty object

root SubGeographicalRegion SubGeographicalRegion SubGeographicalRegion.EnergyPrices
Type: string

Pointer to EnergyPrices object

root SubGeographicalRegion SubGeographicalRegion Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root SubGeographicalRegion SubGeographicalRegion IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root SubGeographicalRegion SubGeographicalRegion IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root SubGeographicalRegion SubGeographicalRegion IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root SubGeographicalRegion SubGeographicalRegion IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root TopologicalIsland
Type: object

Hash table of TopologicalIsland objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root TopologicalIsland TopologicalIsland.json
Type: object

An electrically connected subset of the network. Topological islands can change as the current network state changes, e.g. due to:
- disconnect switches or breakers changing state in a SCADA/EMS.
- manual creation, change or deletion of topological nodes in a planning tool.
Only energised TopologicalNode-s shall be part of the topological island.

No Additional Properties

root TopologicalIsland TopologicalIsland TopologicalIsland.AngleRefTopologicalNode
Type: string

Pointer to TopologicalNode object

root TopologicalIsland TopologicalIsland Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root TopologicalIsland TopologicalIsland IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root TopologicalIsland TopologicalIsland IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root TopologicalIsland TopologicalIsland IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root TopologicalIsland TopologicalIsland IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root EquipmentContainer
Type: object

Hash table of EquipmentContainer objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root EquipmentContainer EquipmentContainer.json
Type: object

A modelling construct to provide a root class for containing equipment.

root EquipmentContainer EquipmentContainer oneOf EquipmentContainer.json
Type: object

A modelling construct to provide a root class for containing equipment.

Same definition as EquipmentContainer
root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer.json
Type: object

Type of EquipmentContainer used to specify Equipment that should be considered "Behind the meter" (BTM)

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer EquipmentContainer.Equipments
Type: array of string

Pointers to Equipment objects

 No Additional Items

Each item of this array must be:

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer EquipmentContainer.Equipments EquipmentPointer
Type: string

Pointer to Equipment object

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf BTMEquipmentContainer IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf Bay.json
Type: object

A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry. A bay typically represents a physical grouping related to modularization of equipment.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf Bay Bay.bayEnergyMeasFlag
Type: boolean

Indicates the presence/absence of energy measurements.

root EquipmentContainer EquipmentContainer oneOf Bay Bay.bayPowerMeasFlag
Type: boolean

Indicates the presence/absence of active/reactive power measurements.

root EquipmentContainer EquipmentContainer oneOf Bay Bay.breakerConfiguration
Type: enum (of string)

Breaker configuration.

Must be one of:

  • "noBreaker"
  • "breakerAndAHalf"
  • "singleBreaker"
  • "doubleBreaker"

root EquipmentContainer EquipmentContainer oneOf Bay Bay.busBarConfiguration
Type: enum (of string)

Busbar configuration.

Must be one of:

  • "doubleBus"
  • "ringBus"
  • "mainWithTransfer"
  • "singleBus"

root EquipmentContainer EquipmentContainer oneOf Bay Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf Bay IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf Bay IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf Bay IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf Bay IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf Feeder.json
Type: object

A collection of equipment for organizational purposes, used for grouping distribution resources.
The organization a feeder does not necessarily reflect connectivity or current operation state.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf Feeder Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf Feeder IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf Feeder IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf Feeder IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf Feeder IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer.json
Type: object

A modelling construct to provide a root class for containment of DC as well as AC equipment. The class differ from the EquipmentContaner for AC in that it may also contain DCNode-s. Hence it can contain both AC and DC equipment.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer DCConverterUnit.operationMode
Type: enum (of string)

The operating mode of an HVDC bipole (bipolar, monopolar metallic return, etc).

Must be one of:

  • "monopolarMetallicReturn"
  • "bipolar"
  • "monopolarGroundReturn"

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf DCEquipmentContainer IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf Plant.json
Type: object

A Plant is a collection of equipment for purposes of generation.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf Plant Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf Plant IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf Plant IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf Plant IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf Plant IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf Line.json
Type: object

Contains equipment beyond a substation belonging to a power transmission line.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf Line Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf Line IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf Line IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf Line IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf Line IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf Substation.json
Type: object

A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf Substation Substation.Region
Type: string

Pointer to SubGeographicalRegion object

root EquipmentContainer EquipmentContainer oneOf Substation Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf Substation IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf Substation IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf Substation IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf Substation IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root EquipmentContainer EquipmentContainer oneOf VoltageLevel.json
Type: object

A collection of equipment at one common system voltage forming a switchgear. The equipment typically consists of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these.

 No Additional Properties

root EquipmentContainer EquipmentContainer oneOf VoltageLevel VoltageLevel.lowVoltageLimit
Type: object or number

The bus bar's low voltage limit.
The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with highVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.

root EquipmentContainer EquipmentContainer oneOf VoltageLevel VoltageLevel.lowVoltageLimit multiplier
Type: enum (of string) Default: "none"

nan

Must be one of:

  • "f"
  • "c"
  • "G"
  • "d"
  • "z"
  • "p"
  • "y"
  • "h"
  • "Y"
  • "a"
  • "none"
  • "k"
  • "m"
  • "n"
  • "E"
  • "da"
  • "T"
  • "M"
  • "P"
  • "Z"
  • "micro"

root EquipmentContainer EquipmentContainer oneOf VoltageLevel VoltageLevel.lowVoltageLimit unit
Type: enum (of string) Default: "V"

nan

Must be one of:

  • "JPerkg"
  • "NPerm"
  • "WPerW"
  • "JPermol"
  • "WPerm2sr"
  • "V"
  • "A2h"
  • "JPerK"
  • "m3Perkg"
  • "HzPerHz"
  • "T"
  • "Vh"
  • "tonne"
  • "JPerm2"
  • "CPerkg"
  • "VPerHz"
  • "ohm"
  • "K"
  • "m3Compensated"
  • "lx"
  • "lPerh"
  • "APerm"
  • "charPers"
  • "katPerm3"
  • "Pas"
  • "ohmPerm"
  • "radPers2"
  • "Btu"
  • "WPers"
  • "h"
  • "lPerl"
  • "l"
  • "As"
  • "cosPhi"
  • "W"
  • "count"
  • "PaPers"
  • "onePerHz"
  • "m3Pers"
  • "KPers"
  • "Vs"
  • "m2Pers"
  • "Ah"
  • "deg"
  • "mPers2"
  • "lm"
  • "d"
  • "JPerkgK"
  • "m"
  • "min"
  • "dB"
  • "Gy"
  • "Nm"
  • "JPerm3"
  • "sPers"
  • "Q"
  • "rev"
  • "N"
  • "Bq"
  • "WPermK"
  • "GyPers"
  • "HPerm"
  • "molPerkg"
  • "molPerm3"
  • "Wb"
  • "VPerm"
  • "WPerm2"
  • "kn"
  • "CPerm2"
  • "anglemin"
  • "Oe"
  • "kgm"
  • "character"
  • "APerA"
  • "A2s"
  • "Qh"
  • "JPers"
  • "Hz"
  • "rad"
  • "kat"
  • "degC"
  • "bar"
  • "M"
  • "molPermol"
  • "kgPerJ"
  • "J"
  • "HzPers"
  • "WPersr"
  • "anglesec"
  • "F"
  • "Mx"
  • "ha"
  • "SPerm"
  • "gal"
  • "mmHg"
  • "m2"
  • "mPers"
  • "V2h"
  • "m3"
  • "G"
  • "H"
  • "mol"
  • "rotPers"
  • "VAh"
  • "mPerm3"
  • "onePerm"
  • "V2"
  • "WPerA"
  • "Pa"
  • "kgPerm3"
  • "CPerm3"
  • "Sv"
  • "S"
  • "JPermolK"
  • "ft3"
  • "Wh"
  • "radPers"
  • "ohmm"
  • "kgm2"
  • "m3Perh"
  • "dBm"
  • "VA"
  • "A2"
  • "s"
  • "therm"
  • "VArh"
  • "cd"
  • "VPerV"
  • "gPerg"
  • "kg"
  • "A"
  • "m3Uncompensated"
  • "ppm"
  • "FPerm"
  • "C"
  • "sr"
  • "none"
  • "VPerVAr"
  • "VAr"
  • "VPerVA"
  • "lPers"

root EquipmentContainer EquipmentContainer oneOf VoltageLevel Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EquipmentContainer EquipmentContainer oneOf VoltageLevel VoltageLevel.highVoltageLimit
Type: object or number

The bus bar's high voltage limit.
The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with lowVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.

Same definition as VoltageLevel.lowVoltageLimit

root EquipmentContainer EquipmentContainer oneOf VoltageLevel IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EquipmentContainer EquipmentContainer oneOf VoltageLevel IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EquipmentContainer EquipmentContainer oneOf VoltageLevel IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EquipmentContainer EquipmentContainer oneOf VoltageLevel IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root EnergyArea
Type: object

Hash table of EnergyArea objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root EnergyArea EnergyArea.json
Type: object

Describes an area having energy production or consumption. Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels.

 No Additional Properties

root EnergyArea EnergyArea SubLoadArea
Type: object

The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

 No Additional Properties

root EnergyArea EnergyArea SubLoadArea Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EnergyArea EnergyArea SubLoadArea IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EnergyArea EnergyArea SubLoadArea IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EnergyArea EnergyArea SubLoadArea IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EnergyArea EnergyArea SubLoadArea IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root EnergyArea EnergyArea Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root EnergyArea EnergyArea IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root EnergyArea EnergyArea IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root EnergyArea EnergyArea IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root EnergyArea EnergyArea IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root LoadGroup
Type: object

Hash table of LoadGroup objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root LoadGroup LoadGroup.json
Type: object

The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

root LoadGroup LoadGroup oneOf ConformLoadGroup.json
Type: object

A group of loads conforming to an allocation pattern.

 No Additional Properties

root LoadGroup LoadGroup oneOf ConformLoadGroup ConformLoadGroup.EnergyConsumers
Type: array of string

Pointers to EnergyConsumer objects

 No Additional Items

Each item of this array must be:

root LoadGroup LoadGroup oneOf ConformLoadGroup ConformLoadGroup.EnergyConsumers EnergyConsumerPointer
Type: string

Pointer to EnergyConsumer object

root LoadGroup LoadGroup oneOf ConformLoadGroup ConformLoadGroup.ConformLoadSchedules
Type: string

Pointer to ConformLoadSchedule object

root LoadGroup LoadGroup oneOf ConformLoadGroup Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root LoadGroup LoadGroup oneOf ConformLoadGroup IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root LoadGroup LoadGroup oneOf ConformLoadGroup IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root LoadGroup LoadGroup oneOf ConformLoadGroup IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root LoadGroup LoadGroup oneOf ConformLoadGroup IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root LoadGroup LoadGroup oneOf NonConformLoadGroup.json
Type: object

Loads that do not follow a daily and seasonal load variation pattern.

 No Additional Properties

root LoadGroup LoadGroup oneOf NonConformLoadGroup NonConformLoadGroup.NonConformLoadSchedules
Type: string

Pointer to NonConformLoadSchedule object

root LoadGroup LoadGroup oneOf NonConformLoadGroup Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root LoadGroup LoadGroup oneOf NonConformLoadGroup IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root LoadGroup LoadGroup oneOf NonConformLoadGroup IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root LoadGroup LoadGroup oneOf NonConformLoadGroup IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root LoadGroup LoadGroup oneOf NonConformLoadGroup IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.
root LoadGroup LoadGroup oneOf LoadGroup.json
Type: object

The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.

Same definition as LoadGroup

root PopulationGroup
Type: object

Hash table of PopulationGroup objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root PopulationGroup PopulationGroup.json
Type: object

nan

 No Additional Properties

root PopulationGroup PopulationGroup PopulationGroup.Location
Type: string

Pointer to Location object

root PopulationGroup PopulationGroup IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root PopulationGroup PopulationGroup IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root PopulationGroup PopulationGroup Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root PopulationGroup PopulationGroup PopulationGroup.medianIncome
Type: object

nan

root PopulationGroup PopulationGroup PopulationGroup.medianIncome unit
Type: enum (of string) Default: null

nan

Must be one of:

  • "GBP"
  • "TTD"
  • "KGS"
  • "UYU"
  • "SGD"
  • "FJD"
  • "STD"
  • "INR"
  • "CDF"
  • "PKR"
  • "MDL"
  • "XPF"
  • "DOP"
  • "AOA"
  • "RON"
  • "IDR"
  • "XAF"
  • "BHD"
  • "PAB"
  • "SDG"
  • "WST"
  • "MVR"
  • "SLL"
  • "CLF"
  • "XCD"
  • "TRY"
  • "MZN"
  • "KWD"
  • "BBD"
  • "PHP"
  • "CRC"
  • "ANG"
  • "DKK"
  • "TOP"
  • "LKR"
  • "CLP"
  • "GNF"
  • "VEF"
  • "IQD"
  • "GEL"
  • "MUR"
  • "MRO"
  • "PGK"
  • "AMD"
  • "ETB"
  • "UAH"
  • "KES"
  • "KMF"
  • "QAR"
  • "SHP"
  • "JPY"
  • "CNY"
  • "NPR"
  • "HTG"
  • "TWD"
  • "BSD"
  • "MKD"
  • "CHF"
  • "CAD"
  • "SCR"
  • "EEK"
  • "LTL"
  • "SZL"
  • "BZD"
  • "LBP"
  • "ILS"
  • "BAM"
  • "BTN"
  • "CUP"
  • "ZAR"
  • "BDT"
  • "TZS"
  • "RSD"
  • "SEK"
  • "LRD"
  • "LAK"
  • "AED"
  • "UZS"
  • "LVL"
  • "KPW"
  • "GYD"
  • "IRR"
  • "DZD"
  • "DJF"
  • "BOB"
  • "BND"
  • "MMK"
  • "NZD"
  • "LSL"
  • "CUC"
  • "BOV"
  • "BWP"
  • "ARS"
  • "RUB"
  • "MNT"
  • "HUF"
  • "MGA"
  • "JMD"
  • "TJS"
  • "MYR"
  • "OMR"
  • "AUD"
  • "YER"
  • "COU"
  • "MOP"
  • "MWK"
  • "HKD"
  • "ZMK"
  • "SAR"
  • "EUR"
  • "GTQ"
  • "THB"
  • "SOS"
  • "ISK"
  • "GHS"
  • "RWF"
  • "TMT"
  • "BMD"
  • "KRW"
  • "SBD"
  • "GMD"
  • "SRD"
  • "MXN"
  • "GIP"
  • "HNL"
  • "NGN"
  • "CZK"
  • "KHR"
  • "ALL"
  • "CVE"
  • "BYR"
  • "PEN"
  • "TND"
  • "KYD"
  • "ERN"
  • "EGP"
  • "ZWL"
  • "MAD"
  • "NAD"
  • "PLN"
  • "KZT"
  • "VND"
  • "LYD"
  • "NOK"
  • "JOD"
  • "BRL"
  • "BIF"
  • "HRK"
  • "NIO"
  • "COP"
  • "UGX"
  • "XOF"
  • "SYP"
  • "AWG"
  • "BGN"
  • "AZN"
  • "USD"
  • "AFN"
  • "VUV"
  • "PYG"
  • "FKP"

root PopulationGroup PopulationGroup IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root PopulationGroup PopulationGroup IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root ProposedAssetSet
Type: object

Hash table of ProposedAssetSet objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root ProposedAssetSet ProposedAssetSet.json
Type: object

A set of assets that should be considered as one particular solution to a design problem Algorithm.

 No Additional Properties

root ProposedAssetSet ProposedAssetSet ProposedAssetSet.ProposedAssets
Type: array of string

Pointers to ProposedAsset objects

 No Additional Items

Each item of this array must be:

root ProposedAssetSet ProposedAssetSet ProposedAssetSet.ProposedAssets ProposedAssetPointer
Type: string

Pointer to ProposedAsset object

root ProposedAssetSet ProposedAssetSet ProposedAssetSet.rank
Type: integer

An indication of the "rank" or quality of the particular solution set with respect to the other solution sets.

root ProposedAssetSet ProposedAssetSet Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root ProposedAssetSet ProposedAssetSet IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root ProposedAssetSet ProposedAssetSet IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root ProposedAssetSet ProposedAssetSet IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root ProposedAssetSet ProposedAssetSet IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.