1. Oracle Utilities REST API for Digital Asset
  2. Tasks
  3. DER Device Management

Register DER Device

post

https://server:port/rest/apis/cross/digitalAssets/derDeviceManagement/register

This REST web service allows the registration of a Distributed Energy Resources (DER) device along with its IEEE 2030.5 nameplate ratings.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : assetInfo
Type: object
Show Source
Nested Schema : customerInfo
Type: object
Show Source
  • Maximum Length: 24
    The business phone of the customer. This value is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 30
    Unique identifier is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 30
    Unique identifier is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 254
    The email address of the customer.
  • Maximum Length: 24
    The home phone of the customer. This value is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 254
    The name of the customer which is commonly in Last Name, First Name syntax. Refer to your CIS to confirm the required syntax.
Nested Schema : locationInfo
Type: object
Show Source
  • Maximum Length: 254
    The first line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The second line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The third line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The fourth line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 60
    Unique identifier is used to derive the metered service point associated to the registration.
  • Maximum Length: 60
    Unique identifier is used to derive the metered service point associated to the registration.
  • Maximum Length: 90
    The city of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 3
    The country of the address. Used to derive the metered service point associated to the registration. This value is optional if address information is provided.
  • Maximum Length: 90
    The county of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 30
    Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions.
  • Maximum Length: 12
    The postal code of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 6
    The state of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 10
    Time Zone
Nested Schema : attributes
Type: object
Show Source
Nested Schema : additionalAttributes
Type: object
Show Source
Nested Schema : DERCapability
Type: object
Show Source
  • Maximum Length: 254
    Control modes supported by the DER. It is a 32-bit Bitmap value, with each bit position indicating whether that mode is supported.
  • Maximum Length: 254
    DER Capability value indicating the voltage and frequency ride-through category I, II, or III.
  • Maximum Length: 254
    Maximum continuous ac current capability of the DER, in amperes (rms).
  • Maximum Length: 254
    Usable energy storage capacity of the DER, in amp hours.
  • Maximum Length: 254
    Maximum apparent power charge rating in voltamperes; may differ from the apparent power maximum rating.
  • Maximum Length: 254
    Maximum active power charge rating in watts.
  • Maximum Length: 254
    Maximum apparent power discharge rating in voltamperes. May differ from the maximum apparent power rating.
  • Maximum Length: 254
    Maximum rate of energy transfer delivered by the storage DER, in watts. Required for combined generation/storage DERs.
  • Maximum Length: 254
    Maximum ac voltage rating in rms volts.
  • Maximum Length: 254
    Maximum apparent power rating in voltamperes.
  • Maximum Length: 254
    Maximum injected reactive power rating in vars.
  • Maximum Length: 254
    Maximum absorbed reactive power rating in vars.
  • Maximum Length: 254
    Active power rating in watts at unity power factor.
  • Maximum Length: 254
    Maximum energy storage capacity of the DER, in watthours
  • Maximum Length: 254
    Minimum power factor displacement capability of the DER when injecting reactive power (over-excited).
  • Maximum Length: 254
    Minimum Power Factor displacement capability of the DER when absorbing reactive power (under-excited).
  • Maximum Length: 254
    Minimum ac voltage rating in rms volts.
  • Maximum Length: 254
    Indication of reactive power and voltage/power control capability.
  • Maximum Length: 254
    Over-excited power factor.
  • Maximum Length: 254
    Active power rating in watts at specified over-excited power factor.
  • Maximum Length: 254
    Reactive susceptance that remains connected to the Area EPS in the cease to energize and trip state.
  • Maximum Length: 254
    Under-excited power factor.
  • Maximum Length: 254
    Active power rating in watts at specified under-excited power factor.
  • Maximum Length: 254
    Nominal ac voltage rating in rms voltse
  • Maximum Length: 254
    Type of DER. As per IEEE 2030.5, 0 - Not applicable / Unknown, 1 - Virtual or mixed DER, 2 - Reciprocating engine, 3 - Fuel cell, 4 - Photovoltaic system, 5 - Combined heat and power, 6 - Other generation system, 80 - Other storage system, 81 - Electric vehicle, 82 - EVSE, 83 - Combined PV and storage, All other values reserved.
Nested Schema : DeviceInformation
Type: object
Show Source
  • Maximum Length: 254
    A unique identifier known as the Long form of device identifier and is the full certificate fingerprint.
  • Maximum Length: 254
    Hardware version of the DER device.
  • Maximum Length: 254
    Manufacturer of the DER device.
  • Maximum Length: 254
    Model of the DER device.
  • Maximum Length: 254
    Serial Number allocated by the DER Manufacturer.
  • Maximum Length: 254
    Software version of the DER device.
Nested Schema : additionalAttributeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : assetInfo
Type: object
Show Source
Nested Schema : customerInfo
Type: object
Show Source
  • Maximum Length: 24
    The business phone of the customer. This value is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 30
    Unique identifier is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 30
    Unique identifier is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 254
    The email address of the customer.
  • Maximum Length: 24
    The home phone of the customer. This value is used to derive the existing customer and metered service record associated to the registration.
  • Maximum Length: 254
    The name of the customer which is commonly in Last Name, First Name syntax. Refer to your CIS to confirm the required syntax.
Nested Schema : locationInfo
Type: object
Show Source
  • Maximum Length: 254
    The first line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The second line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The third line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 254
    The fourth line of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 60
    Unique identifier is used to derive the metered service point associated to the registration.
  • Maximum Length: 60
    Unique identifier is used to derive the metered service point associated to the registration.
  • Maximum Length: 90
    The city of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 3
    The country of the address. Used to derive the metered service point associated to the registration. This value is optional if address information is provided.
  • Maximum Length: 90
    The county of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 30
    Division is used to define the jurisdiction in which the customer is located. A utility name or acronym is commonly used for division, while state information can be used for utilities that operate across multiple regions.
  • Maximum Length: 12
    The postal code of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 6
    The state of the address. Used to derive the metered service point associated to the registration.
  • Maximum Length: 10
    Time Zone
Nested Schema : attributes
Type: object
Show Source
Nested Schema : additionalAttributes
Type: object
Show Source
Nested Schema : DERCapability
Type: object
Show Source
  • Maximum Length: 254
    Control modes supported by the DER. It is a 32-bit Bitmap value, with each bit position indicating whether that mode is supported.
  • Maximum Length: 254
    DER Capability value indicating the voltage and frequency ride-through category I, II, or III.
  • Maximum Length: 254
    Maximum continuous ac current capability of the DER, in amperes (rms).
  • Maximum Length: 254
    Usable energy storage capacity of the DER, in amp hours.
  • Maximum Length: 254
    Maximum apparent power charge rating in voltamperes; may differ from the apparent power maximum rating.
  • Maximum Length: 254
    Maximum active power charge rating in watts.
  • Maximum Length: 254
    Maximum apparent power discharge rating in voltamperes. May differ from the maximum apparent power rating.
  • Maximum Length: 254
    Maximum rate of energy transfer delivered by the storage DER, in watts. Required for combined generation/storage DERs.
  • Maximum Length: 254
    Maximum ac voltage rating in rms volts.
  • Maximum Length: 254
    Maximum apparent power rating in voltamperes.
  • Maximum Length: 254
    Maximum injected reactive power rating in vars.
  • Maximum Length: 254
    Maximum absorbed reactive power rating in vars.
  • Maximum Length: 254
    Active power rating in watts at unity power factor.
  • Maximum Length: 254
    Maximum energy storage capacity of the DER, in watthours
  • Maximum Length: 254
    Minimum power factor displacement capability of the DER when injecting reactive power (over-excited).
  • Maximum Length: 254
    Minimum Power Factor displacement capability of the DER when absorbing reactive power (under-excited).
  • Maximum Length: 254
    Minimum ac voltage rating in rms volts.
  • Maximum Length: 254
    Indication of reactive power and voltage/power control capability.
  • Maximum Length: 254
    Over-excited power factor.
  • Maximum Length: 254
    Active power rating in watts at specified over-excited power factor.
  • Maximum Length: 254
    Reactive susceptance that remains connected to the Area EPS in the cease to energize and trip state.
  • Maximum Length: 254
    Under-excited power factor.
  • Maximum Length: 254
    Active power rating in watts at specified under-excited power factor.
  • Maximum Length: 254
    Nominal ac voltage rating in rms voltse
  • Maximum Length: 254
    Type of DER. As per IEEE 2030.5, 0 - Not applicable / Unknown, 1 - Virtual or mixed DER, 2 - Reciprocating engine, 3 - Fuel cell, 4 - Photovoltaic system, 5 - Combined heat and power, 6 - Other generation system, 80 - Other storage system, 81 - Electric vehicle, 82 - EVSE, 83 - Combined PV and storage, All other values reserved.
Nested Schema : DeviceInformation
Type: object
Show Source
  • Maximum Length: 254
    A unique identifier known as the Long form of device identifier and is the full certificate fingerprint.
  • Maximum Length: 254
    Hardware version of the DER device.
  • Maximum Length: 254
    Manufacturer of the DER device.
  • Maximum Length: 254
    Model of the DER device.
  • Maximum Length: 254
    Serial Number allocated by the DER Manufacturer.
  • Maximum Length: 254
    Software version of the DER device.
Nested Schema : additionalAttributeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : X1_RegDERDvc
Type: object
Show Source
Nested Schema : exception
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • Maximum Length: 60
    Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
  • Maximum Length: 60
    URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
  • serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top