Jump to

• Request
• Response

Create Measuring Component

post

https://server:port/ouaf/rest/apis/meter/devices/measuringComponents/

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• businessObject: string
  Maximum Length: 30

  Business Object

  Example: D1-IntervalChannel
• consumptionReferenceMC: object consumptionReferenceMC
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2011-04-20T09:03:54-07:00
• deviceConfigurationId: string
  Maximum Length: 12

  Device Configuration ID is a system assigned random number that stays with a device configuration record.

  Example: 959682277977
• fallBackVeeGroups: object fallBackVeeGroups
• fullScale: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Full Scale

  Example: 0E-7
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak
• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID is a system assigned random number that stays with measuring component record.

  Example: 061924013788
• measuringComponentMultiplier: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  The meter multiplier for the channel.

  Example: 1
• measuringComponentType: object measuringComponentType
  Type of Measuring Component
• numberOfDigitsLeft: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits left is the number of digits to the left of the decimal point that the reading can contain.

  Example: 3
• numberOfDigitsRight: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits right is the number of digits to the right of the decimal point that the reading can contain.

  Example: 2
• readSequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Read Sequence

  Example: 0
• veeGroups: object veeGroups
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID is a system assigned random number that stays with measuring component record.",
            "example":"061924013788"
        },
        "measuringComponentType":{
            "type":"object",
            "description":"Type of Measuring Component",
            "properties":{
                "measuringComponentType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Measuring Component",
                    "example":"MKA SMART KWH"
                }
            }
        },
        "deviceConfigurationId":{
            "type":"string",
            "maxLength":12,
            "description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.",
            "example":"959682277977"
        },
        "consumptionReferenceMC":{
            "type":"object",
            "properties":{
                "consumptionReferenceMCId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
                }
            }
        },
        "businessObject":{
            "type":"string",
            "maxLength":30,
            "description":"Business Object",
            "example":"D1-IntervalChannel"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"
        },
        "numberOfDigitsLeft":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.",
            "example":"3"
        },
        "numberOfDigitsRight":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.",
            "example":"2"
        },
        "measuringComponentMultiplier":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"The meter multiplier for the channel.",
            "example":"1"
        },
        "readSequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Read Sequence",
            "example":"0"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2011-04-20T09:03:54-07:00"
        },
        "fullScale":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Full Scale",
            "example":"0E-7"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "veeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        },
        "fallBackVeeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1MeasuComp"
    }
}

Nested Schema : consumptionReferenceMC

Type: object

Show Source

• consumptionReferenceMCId: string
  Maximum Length: 12

  Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement.

{
    "type":"object",
    "properties":{
        "consumptionReferenceMCId":{
            "type":"string",
            "maxLength":12,
            "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
        }
    }
}

Nested Schema : fallBackVeeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : measuringComponentType

Type: object

Type of Measuring Component

Show Source

• measuringComponentType: string
  Maximum Length: 30

  Type of Measuring Component

  Example: MKA SMART KWH

{
    "type":"object",
    "description":"Type of Measuring Component",
    "properties":{
        "measuringComponentType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Measuring Component",
            "example":"MKA SMART KWH"
        }
    }
}

Nested Schema : veeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• businessObject: string
  Maximum Length: 30

  Business Object

  Example: D1-IntervalChannel
• consumptionReferenceMC: object consumptionReferenceMC
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2011-04-20T09:03:54-07:00
• deviceConfigurationId: string
  Maximum Length: 12

  Device Configuration ID is a system assigned random number that stays with a device configuration record.

  Example: 959682277977
• fallBackVeeGroups: object fallBackVeeGroups
• fullScale: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Full Scale

  Example: 0E-7
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak
• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID is a system assigned random number that stays with measuring component record.

  Example: 061924013788
• measuringComponentMultiplier: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  The meter multiplier for the channel.

  Example: 1
• measuringComponentType: object measuringComponentType
  Type of Measuring Component
• numberOfDigitsLeft: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits left is the number of digits to the left of the decimal point that the reading can contain.

  Example: 3
• numberOfDigitsRight: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits right is the number of digits to the right of the decimal point that the reading can contain.

  Example: 2
• readSequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Read Sequence

  Example: 0
• veeGroups: object veeGroups
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID is a system assigned random number that stays with measuring component record.",
            "example":"061924013788"
        },
        "measuringComponentType":{
            "type":"object",
            "description":"Type of Measuring Component",
            "properties":{
                "measuringComponentType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Measuring Component",
                    "example":"MKA SMART KWH"
                }
            }
        },
        "deviceConfigurationId":{
            "type":"string",
            "maxLength":12,
            "description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.",
            "example":"959682277977"
        },
        "consumptionReferenceMC":{
            "type":"object",
            "properties":{
                "consumptionReferenceMCId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
                }
            }
        },
        "businessObject":{
            "type":"string",
            "maxLength":30,
            "description":"Business Object",
            "example":"D1-IntervalChannel"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"
        },
        "numberOfDigitsLeft":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.",
            "example":"3"
        },
        "numberOfDigitsRight":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.",
            "example":"2"
        },
        "measuringComponentMultiplier":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"The meter multiplier for the channel.",
            "example":"1"
        },
        "readSequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Read Sequence",
            "example":"0"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2011-04-20T09:03:54-07:00"
        },
        "fullScale":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Full Scale",
            "example":"0E-7"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "veeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        },
        "fallBackVeeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1MeasuComp"
    }
}

Nested Schema : consumptionReferenceMC

Type: object

Show Source

• consumptionReferenceMCId: string
  Maximum Length: 12

  Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement.

{
    "type":"object",
    "properties":{
        "consumptionReferenceMCId":{
            "type":"string",
            "maxLength":12,
            "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
        }
    }
}

Nested Schema : fallBackVeeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : measuringComponentType

Type: object

Type of Measuring Component

Show Source

• measuringComponentType: string
  Maximum Length: 30

  Type of Measuring Component

  Example: MKA SMART KWH

{
    "type":"object",
    "description":"Type of Measuring Component",
    "properties":{
        "measuringComponentType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Measuring Component",
            "example":"MKA SMART KWH"
        }
    }
}

Nested Schema : veeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1MeasuComp

Type: object

Show Source

• _self: string
  _self
• adjustLatestMeasurementDateTime: string (date-time)
  Adjust Latest Measurement Date/Time
• businessObject: string
  Maximum Length: 30

  Business Object

  Example: D1-IntervalChannel
• consumptionReferenceMC: object consumptionReferenceMC
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2011-04-20T09:03:54-07:00
• deviceConfiguration: object deviceConfiguration
• fallBackVeeGroups: object fallBackVeeGroups
• fullScale: number
  Minimum Value: -1.0E11

  Maximum Value: 1.0E11

  Full Scale

  Example: 0E-7
• howToUse: string
  Allowed Values: [ "+ ", "- ", "C ", "P " ]

  How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage. * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak
• latestMeasurementDateTime: string (date-time)
  Latest Measurement Date/Time
• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID is a system assigned random number that stays with measuring component record.

  Example: 061924013788
• measuringComponentMultiplier: number
  Minimum Value: -999999.999999

  Maximum Value: 999999.999999

  The meter multiplier for the channel.

  Example: 1
• measuringComponentType: object measuringComponentType
  Type of Measuring Component
• mostRecentMeasurementDateTime: string (date-time)
  This date/time corresponds to the final measurement with the latest measurement date/time that has been processed for this measuring component regardless of the final condition (i.e. quality).
• mostRecentMeasurementReadingCondition: string
  Maximum Length: 6

  Most Recent Measurement Reading Condition
• mostRecentMeasurementReadingValue: number
  Minimum Value: 0

  Maximum Value: 9.999999999999998E9

  Most Recent Measurement Reading Value

  Example: 0
• mostRecentNonEstimatedMeasurementDateTime: string (date-time)
  This date/time corresponds to the final measurement with the latest measurement date/time that has a final condition that is non-estimated.
• numberOfDigitsLeft: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits left is the number of digits to the left of the decimal point that the reading can contain.

  Example: 3
• numberOfDigitsRight: number
  Minimum Value: -99999

  Maximum Value: 99999

  Number of digits right is the number of digits to the right of the decimal point that the reading can contain.

  Example: 2
• readSequence: number
  Minimum Value: -99999

  Maximum Value: 99999

  Read Sequence

  Example: 0
• veeGroups: object veeGroups
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID is a system assigned random number that stays with measuring component record.",
            "example":"061924013788"
        },
        "measuringComponentType":{
            "type":"object",
            "description":"Type of Measuring Component",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "measuringComponentType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of Measuring Component",
                    "example":"MKA SMART KWH"
                }
            }
        },
        "deviceConfiguration":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "deviceConfigurationId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.",
                    "example":"959682277977"
                }
            }
        },
        "consumptionReferenceMC":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "consumptionReferenceMCId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
                }
            }
        },
        "businessObject":{
            "type":"string",
            "maxLength":30,
            "description":"Business Object",
            "example":"D1-IntervalChannel"
        },
        "howToUse":{
            "type":"string",
            "enum":[
                "+   ",
                "-   ",
                "C   ",
                "P   "
            ],
            "description":"How to Use indicates how the channel is used (additive, subtractive, peak, or check) when calculating usage.\n* `+   ` - Additive,\n* `-   ` - Subtractive,\n* `C   ` - Check,\n* `P   ` - Peak"
        },
        "numberOfDigitsLeft":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits left is the number of digits to the left of the decimal point that the reading can contain.",
            "example":"3"
        },
        "numberOfDigitsRight":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Number of digits right is the number of digits to the right of the decimal point that the reading can contain.",
            "example":"2"
        },
        "measuringComponentMultiplier":{
            "type":"number",
            "maximum":999999.999999,
            "minimum":-999999.999999,
            "description":"The meter multiplier for the channel.",
            "example":"1"
        },
        "readSequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Read Sequence",
            "example":"0"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2011-04-20T09:03:54-07:00"
        },
        "mostRecentMeasurementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"This date/time corresponds to the final measurement with the latest measurement date/time that has been processed for this measuring component regardless of the final condition (i.e. quality)."
        },
        "fullScale":{
            "type":"number",
            "maximum":1.0E11,
            "minimum":-1.0E11,
            "description":"Full Scale",
            "example":"0E-7"
        },
        "mostRecentNonEstimatedMeasurementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"This date/time corresponds to the final measurement with the latest measurement date/time that has a final condition that is non-estimated."
        },
        "adjustLatestMeasurementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Adjust Latest Measurement Date/Time"
        },
        "latestMeasurementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Latest Measurement Date/Time"
        },
        "mostRecentMeasurementReadingCondition":{
            "type":"string",
            "maxLength":6,
            "description":"Most Recent Measurement Reading Condition"
        },
        "mostRecentMeasurementReadingValue":{
            "type":"number",
            "maximum":9.999999999999998E9,
            "minimum":0,
            "description":"Most Recent Measurement Reading Value",
            "example":"0"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "veeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        },
        "fallBackVeeGroups":{
            "type":"object",
            "properties":{
                "initialLoad":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "initialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "streamingInitialLoad":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "streamingInitialLoad":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "estimation":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "estimation":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "manualOverride":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "manualOverride":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                },
                "projection":{
                    "type":"object",
                    "properties":{
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        },
                        "projection":{
                            "type":"string",
                            "maxLength":30,
                            "description":"VEE Group"
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1MeasuComp"
    }
}

Nested Schema : consumptionReferenceMC

Type: object

Show Source

• _link: string
  _link
• consumptionReferenceMCId: string
  Maximum Length: 12

  Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "consumptionReferenceMCId":{
            "type":"string",
            "maxLength":12,
            "description":"Related scalar measuring component. Used when adjusting interval measurement data to an existing scalar measurement."
        }
    }
}

Nested Schema : deviceConfiguration

Type: object

Show Source

• _link: string
  _link
• deviceConfigurationId: string
  Maximum Length: 12

  Device Configuration ID is a system assigned random number that stays with a device configuration record.

  Example: 959682277977

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "deviceConfigurationId":{
            "type":"string",
            "maxLength":12,
            "description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.",
            "example":"959682277977"
        }
    }
}

Nested Schema : fallBackVeeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : measuringComponentType

Type: object

Type of Measuring Component

Show Source

• _link: string
  _link
• measuringComponentType: string
  Maximum Length: 30

  Type of Measuring Component

  Example: MKA SMART KWH

{
    "type":"object",
    "description":"Type of Measuring Component",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "measuringComponentType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of Measuring Component",
            "example":"MKA SMART KWH"
        }
    }
}

Nested Schema : veeGroups

Type: object

Show Source

• estimation: object estimation
• initialLoad: object initialLoad
• manualOverride: object manualOverride
• projection: object projection
• streamingInitialLoad: object streamingInitialLoad

{
    "type":"object",
    "properties":{
        "initialLoad":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "initialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "streamingInitialLoad":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "streamingInitialLoad":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "estimation":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "estimation":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "manualOverride":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "manualOverride":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        },
        "projection":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "projection":{
                    "type":"string",
                    "maxLength":30,
                    "description":"VEE Group"
                }
            }
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• _link: string
  _link
• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• _link: string
  _link
• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• _link: string
  _link
• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• _link: string
  _link
• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• _link: string
  _link
• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : estimation

Type: object

Show Source

• _link: string
  _link
• estimation: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "estimation":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : initialLoad

Type: object

Show Source

• _link: string
  _link
• initialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "initialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : manualOverride

Type: object

Show Source

• _link: string
  _link
• manualOverride: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "manualOverride":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : projection

Type: object

Show Source

• _link: string
  _link
• projection: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "projection":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

Nested Schema : streamingInitialLoad

Type: object

Show Source

• _link: string
  _link
• streamingInitialLoad: string
  Maximum Length: 30

  VEE Group

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "streamingInitialLoad":{
            "type":"string",
            "maxLength":30,
            "description":"VEE Group"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  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.
• problemType: string
  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: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  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.
• problemType: string
  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: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top