Group

Type: object
No Additional Properties

ConnectivityNodeContainerContainer

Type: object

Hash table of ConnectivityNodeContainer objects

No Additional Properties

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

Property name regular expression: ^.+$

ConnectivityNodeContainer

Type: object

A base class for all objects that may contain connectivity nodes or topological nodes.

No Additional Properties

ConnectivityNodeContainer

Type: object

A base class for all objects that may contain connectivity nodes or topological nodes.

No Additional Properties

AssetInfo_anyOfPointer

Type: object

Pointer to AssetInfo object

AssetInfo_Pointer

Type: string

Pointer to AssetInfo object

Must match regular expression: ^AssetInfo::'(.+)'$

PowerTransformerInfo_Pointer

Type: string

Pointer to PowerTransformerInfo object

Must match regular expression: ^PowerTransformerInfo::'(.+)'$

WireInfo_Pointer

Type: string

Pointer to WireInfo object

Must match regular expression: ^WireInfo::'(.+)'$

SwitchInfo_Pointer

Type: string

Pointer to SwitchInfo object

Must match regular expression: ^SwitchInfo::'(.+)'$

ShuntCompensatorInfo_Pointer

Type: string

Pointer to ShuntCompensatorInfo object

Must match regular expression: ^ShuntCompensatorInfo::'(.+)'$

WireAssemblyInfo_Pointer

Type: string

Pointer to WireAssemblyInfo object

Must match regular expression: ^WireAssemblyInfo::'(.+)'$

TransformerEndInfo_Pointer

Type: string

Pointer to TransformerEndInfo object

Must match regular expression: ^TransformerEndInfo::'(.+)'$

TapChangerInfo_Pointer

Type: string

Pointer to TapChangerInfo object

Must match regular expression: ^TapChangerInfo::'(.+)'$

WireSpacingInfo_Pointer

Type: string

Pointer to WireSpacingInfo object

Must match regular expression: ^WireSpacingInfo::'(.+)'$

TransformerTankInfo_Pointer

Type: string

Pointer to TransformerTankInfo object

Must match regular expression: ^TransformerTankInfo::'(.+)'$

CableInfo_Pointer

Type: string

Pointer to CableInfo object

Must match regular expression: ^CableInfo::'(.+)'$

OverheadWireInfo_Pointer

Type: string

Pointer to OverheadWireInfo object

Must match regular expression: ^OverheadWireInfo::'(.+)'$

ConcentricNeutralCableInfo_Pointer

Type: string

Pointer to ConcentricNeutralCableInfo object

Must match regular expression: ^ConcentricNeutralCableInfo::'(.+)'$

TapeShieldCableInfo_Pointer

Type: string

Pointer to TapeShieldCableInfo object

Must match regular expression: ^TapeShieldCableInfo::'(.+)'$

GenericAction_PointerArray

Type: array of string

Pointers to GenericAction objects

No Additional Items

Each item of this array must be:

Location_anyOfPointer

Type: object

Pointer to Location object

Location_Pointer

Type: string

Pointer to Location object

Must match regular expression: ^Location::'(.+)'$

ProposedSiteLocation_Pointer

Type: string

Pointer to ProposedSiteLocation object

Must match regular expression: ^ProposedSiteLocation::'(.+)'$

ConnectivityNode_PointerArray

Type: array of string

Pointers to ConnectivityNode objects

No Additional Items

Each item of this array must be:

TopologicalNode_PointerArray

Type: array of string

Pointers to TopologicalNode objects

No Additional Items

Each item of this array must be:

lowVoltageLimit

Type: Voltage

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.

bayEnergyMeasFlag

Type: boolean

Indicates the presence/absence of energy measurements.

bayPowerMeasFlag

Type: boolean

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

breakerConfiguration

Type: BreakerConfiguration

Breaker configuration.

busBarConfiguration

Type: BusbarConfiguration

Busbar configuration.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "ConnectivityNodeContainer"

operationMode

Type: DCConverterOperatingModeKind

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

name

Type: string

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

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.

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.

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.

highVoltageLimit

Type: Voltage

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.

BTMEquipmentContainer

Type: object

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

No Additional Properties

Equipment_PointerArray

Type: array of string

Pointers to Equipment objects

No Additional Items

Each item of this array must be:

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "BTMEquipmentContainer"

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.

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.

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.

name

Type: string

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

Bay

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

bayEnergyMeasFlag

Type: boolean

Indicates the presence/absence of energy measurements.

bayPowerMeasFlag

Type: boolean

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

breakerConfiguration

Type: BreakerConfiguration

Breaker configuration.

busBarConfiguration

Type: BusbarConfiguration

Busbar configuration.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Bay"

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.

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.

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.

name

Type: string

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

Circuit

Type: object
No Additional Properties

SubGeographicalRegion_Pointer

Type: string

Pointer to SubGeographicalRegion object

Must match regular expression: ^SubGeographicalRegion::'(.+)'$

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Circuit"

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.

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.

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.

name

Type: string

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

DCEquipmentContainer

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

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "DCEquipmentContainer"

operationMode

Type: DCConverterOperatingModeKind

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

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.

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.

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.

name

Type: string

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

DCLine

Type: object

Overhead lines and/or cables connecting two or more HVDC substations.

No Additional Properties

SubGeographicalRegion_Pointer

Type: string

Pointer to SubGeographicalRegion object

Must match regular expression: ^SubGeographicalRegion::'(.+)'$

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "DCLine"

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.

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.

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.

name

Type: string

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

EquipmentContainer

Type: object

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

No Additional Properties

lowVoltageLimit

Type: Voltage

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.

bayEnergyMeasFlag

Type: boolean

Indicates the presence/absence of energy measurements.

bayPowerMeasFlag

Type: boolean

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

breakerConfiguration

Type: BreakerConfiguration

Breaker configuration.

busBarConfiguration

Type: BusbarConfiguration

Busbar configuration.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "EquipmentContainer"

operationMode

Type: DCConverterOperatingModeKind

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

name

Type: string

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

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.

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.

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.

highVoltageLimit

Type: Voltage

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.

Feeder

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

Substation_PointerArray

Type: array of string

Pointers to Substation objects

No Additional Items

Each item of this array must be:

Substation_Pointer

Type: string

Pointer to Substation object

Must match regular expression: ^Substation::'(.+)'$

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Feeder"

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.

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.

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.

name

Type: string

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

Line

Type: object

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

No Additional Properties

SubGeographicalRegion_Pointer

Type: string

Pointer to SubGeographicalRegion object

Must match regular expression: ^SubGeographicalRegion::'(.+)'$

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Line"

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.

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.

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.

name

Type: string

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

Microgrid

Type: object
No Additional Properties

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Microgrid"

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.

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.

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.

name

Type: string

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

Plant

Type: object

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

No Additional Properties

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Plant"

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.

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.

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.

name

Type: string

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

Substation

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

SubGeographicalRegion_Pointer

Type: string

Pointer to SubGeographicalRegion object

Must match regular expression: ^SubGeographicalRegion::'(.+)'$

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "Substation"

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.

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.

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.

name

Type: string

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

VoltageLevel

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

BaseVoltage_PointerArray

Type: array of string

Pointers to BaseVoltage objects

No Additional Items

Each item of this array must be:

lowVoltageLimit

Type: Voltage

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.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "VoltageLevel"

highVoltageLimit

Type: Voltage

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.

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.

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.

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.

name

Type: string

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

EnergyAreaContainer

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: ^.+$

EnergyArea

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.

EnergyArea

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

Equipment_PointerArray

Type: array of string

Pointers to Equipment objects

Same definition as EquipmentContainer.Equipments

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "EnergyArea"

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.

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.

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.

name

Type: string

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

LoadArea

Type: object

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

No Additional Properties

LoadArea_PointerArray

Type: array of string

Pointers to LoadArea objects

No Additional Items

Each item of this array must be:

LoadArea_Pointer

Type: string

Pointer to LoadArea object

Equipment_PointerArray

Type: array of string

Pointers to Equipment objects

Same definition as EquipmentContainer.Equipments

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "LoadArea"

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.

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.

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.

name

Type: string

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

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

LoadGroup_PointerArray

Type: array of string

Pointers to LoadGroup objects

No Additional Items

Each item of this array must be:

LoadGroupPointer

Type: string

Pointer to LoadGroup object

Equipment_PointerArray

Type: array of string

Pointers to Equipment objects

Same definition as EquipmentContainer.Equipments

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "SubLoadArea"

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.

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.

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.

name

Type: string

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

GeographicalRegionContainer

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: ^.+$

GeographicalRegion

Type: object

A geographical region of a power system network model.

No Additional Properties

SubGeographicalRegion_PointerArray

Type: array of string

Pointers to SubGeographicalRegion objects

No Additional Items

Each item of this array must be:

SubGeographicalRegion_Pointer

Type: string

Pointer to SubGeographicalRegion object

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "GeographicalRegion"

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.

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.

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.

name

Type: string

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

LoadGroupContainer

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: ^.+$

LoadGroup

Type: object

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

LoadGroup

Type: object

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

No Additional Properties

ProposedSiteLocation_PointerArray

Type: array of string

Pointers to ProposedSiteLocation objects

No Additional Items

Each item of this array must be:

ProposedSiteLocation_Pointer

Type: string

Pointer to ProposedSiteLocation object

EnergyConsumer_PointerArray

Type: array of string

Pointers to EnergyConsumer objects

No Additional Items

Each item of this array must be:

EnergyConsumerPointer

Type: string

Pointer to EnergyConsumer object

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "LoadGroup"

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.

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.

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.

name

Type: string

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

ConformLoadGroup

Type: object

A group of loads conforming to an allocation pattern.

No Additional Properties

ConformLoad_PointerArray

Type: array of string

Pointers to ConformLoad objects

No Additional Items

Each item of this array must be:

ConformLoad_Pointer

Type: string

Pointer to ConformLoad object

ProposedSiteLocation_PointerArray

Type: array of string

Pointers to ProposedSiteLocation objects

Same definition as LoadGroup.ProposedSiteLocations

EnergyConsumer_PointerArray

Type: array of string

Pointers to EnergyConsumer objects

Same definition as LoadGroup.EnergyConsumers

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "ConformLoadGroup"

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.

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.

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.

name

Type: string

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

NonConformLoadGroup

Type: object

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

No Additional Properties

ProposedSiteLocation_PointerArray

Type: array of string

Pointers to ProposedSiteLocation objects

Same definition as LoadGroup.ProposedSiteLocations

EnergyConsumer_PointerArray

Type: array of string

Pointers to EnergyConsumer objects

Same definition as LoadGroup.EnergyConsumers

NonConformLoad_PointerArray

Type: array of string

Pointers to NonConformLoad objects

No Additional Items

Each item of this array must be:

NonConformLoad_Pointer

Type: string

Pointer to NonConformLoad object

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "NonConformLoadGroup"

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.

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.

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.

name

Type: string

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

PopulationGroupContainer

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: ^.+$

PopulationGroup

Type: object
No Additional Properties

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.

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.

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "PopulationGroup"

medianIncome

Type: object

nan

No Additional Properties

UnitMultiplier

Type: enum (of string) Default: "none"

nan

Must be one of:

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

Currency

Type: enum (of string) Default: null

nan

Must be one of:

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

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.

name

Type: string

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

ProposedAssetSetContainer

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: ^.+$

ProposedAssetSet

Type: object

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

No Additional Properties

ProposedAsset_PointerArray

Type: array of string

Pointers to ProposedAsset objects

No Additional Items

Each item of this array must be:

ProposedAssetPointer

Type: string

Pointer to ProposedAsset object

EstimatedCost_PointerArray

Type: array of string

Pointers to EstimatedCost objects

No Additional Items

Each item of this array must be:

EstimatedCost_Pointer

Type: string

Pointer to EstimatedCost object

rank

Type: integer

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

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "ProposedAssetSet"

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.

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.

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.

name

Type: string

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

SubGeographicalRegionContainer

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: ^.+$

SubGeographicalRegion

Type: object

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

No Additional Properties

CoincidentPeakPrices_Pointer

Type: string

Pointer to CoincidentPeakPrices object

Must match regular expression: ^CoincidentPeakPrices::'(.+)'$

ProposedSiteLocation_PointerArray

Type: array of string

Pointers to ProposedSiteLocation objects

Same definition as LoadGroup.ProposedSiteLocations

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "SubGeographicalRegion"

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.

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.

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.

name

Type: string

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

TopologicalIslandContainer

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: ^.+$

TopologicalIsland

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

TopologicalNode_Pointer

Type: string

Pointer to TopologicalNode object

Must match regular expression: ^TopologicalNode::'(.+)'$

TopologicalNode_PointerArray

Type: array of string

Pointers to TopologicalNode objects

Same definition as ConnectivityNodeContainer.TopologicalNode

cimObjectType

Type: enum (of string)

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

Must be one of:

  • "TopologicalIsland"

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.

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.

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.

name

Type: string

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