1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Usage
  4. Usage Transaction

Get Usage Transaction

get

https://server:port/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}

This Operation handles the Integration Suite API to Get Usage Transaction

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : D1UsgTransac
Type: object
Show Source
Nested Schema : calculationGroup
Type: object
Show Source
Nested Schema : characteristics
Type: object
Show Source
Nested Schema : dateBreaks
Type: object
Show Source
Nested Schema : exceptions
Type: object
Show Source
Nested Schema : intervalMeasuringComponent
Type: object
Show Source
Nested Schema : measurementCycle
Type: object
Measurement Cycle specifies the schedule used for when the service point is visited and the the device read.
Show Source
Nested Schema : nextActions
Type: object
Show Source
Nested Schema : previousUsageTransaction
Type: object
Show Source
Nested Schema : scalarMeasuringComponent
Type: object
Show Source
  • Allowed Values: [ "D2AE", "D2DE" ]
    Allow Estimate indicates whether or not to allow use of estimated measurement data when calculating usage. * `D2AE` - Allow Estimates, * `D2DE` - Do Not Allow Estimates
    Example: D2AE
  • Defines the start date and time for the 'end range' of the usage period.
    Example: 2013-01-03T00:00:00-08:00
  • Defines the end date and time for the 'end range' of the usage period.
    Example: 2013-01-03T00:00:00-08:00
  • Allowed Values: [ "D2SC", "D2SP" ]
    End Range Option indicates the end range option. Valid values include "Specified" and "Derive Using Service Cycle Schedule" * `D2SC` - Derive Using Service Cycle Schedule, * `D2SP` - Specified
    Example: D2SC
  • Estimate Date indicates the date on which estimated measurement data used in the usage calculation was estimated.
  • Allowed Values: [ "D1EF", "D1ET" ]
    Estimate Time * `D1EF` - End Date Time From, * `D1ET` - End Date Time To
    Example: D1EF
  • Allowed Values: [ "D2NO", "D2YS" ]
    Is Estimate indicates if estimated measurement data was used in the usage calculation. * `D2NO` - No, * `D2YS` - Yes
    Example: D2NO
  • Minimum Value: -999
    Maximum Value: 999
    Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date.
  • Minimum Value: -999
    Maximum Value: 999
    Minimum Offset Days / Maximum Offset Days are used when End Range Option is set to "Dervice Using Service Cycle Schedule", these values define a range of days for the end date of the usage transaction, based on the Service Cycle Schedule date.
  • Defines the start date and time of the usage period.
    Example: 2013-01-02T00:00:00-08:00
Nested Schema : serviceQuantitiesData
Type: object
Show Source
Nested Schema : skipDetails
Type: object
Show Source
  • The next scheduled read date for the device from which the measurements used to create the usage transaction came.
  • Allowed Values: [ "D2NO", "D2YS" ]
    A flag that indicates if the usage transaction should be skipped. * `D2NO` - No, * `D2YS` - Yes
    Example: D2NO
  • Allowed Values: [ "D2NS" ]
    Reason for skipping the usage transaction. * `D2NS` - No Scheduled Read
    Example: D2NS
Nested Schema : subUsageToDoIds
Type: object
Show Source
Nested Schema : subUsageTransactions
Type: object
Show Source
Nested Schema : traces
Type: object
Show Source
Nested Schema : usageAdjustmentProfileFactors
Type: object
Show Source
Nested Schema : usagePeriods
Type: object
Show Source
Nested Schema : usageSubscription
Type: object
Show Source
Nested Schema : usageTransactionReadingDetails
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValueForeignKey
Type: object
Show Source
Nested Schema : dateBreaksList
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the usage transaction (and its related account).
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : messageParameters
Type: object
Show Source
Nested Schema : messageParametersList
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 2000
    Message Parameter Value
  • Allowed Values: [ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
    Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameter
    Example: AMT
  • Minimum Value: -999
    Maximum Value: 999
    Message Parameter Sequence
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : calculationGroup
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : messageParameters
Type: object
Show Source
Nested Schema : messageParametersList
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 2000
    Message Parameter Value
  • Allowed Values: [ "AMT ", "DATE", "DTTM", "DUR ", "FLD ", "MMDD", "MSG ", "NBR ", "SRVC", "TBL ", "TIME" ]
    Message Parameter Type * `AMT ` - Amount parameter, * `DATE` - Date format parameter, * `DTTM` - Date/time format parameter, * `DUR ` - Duration parameter, * `FLD ` - Field name parameter, * `MMDD` - Month/Day format parameter, * `MSG ` - Message parameter, * `NBR ` - Numeric parameter, * `SRVC` - Service name parameter, * `TBL ` - Table name parameter, * `TIME` - Time format parameter
    Example: AMT
  • Minimum Value: -999
    Maximum Value: 999
    Message Parameter Sequence
Nested Schema : profileFactorsList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : usagePeriodsList
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : itemDetail
Type: object
Show Source
Nested Schema : serviceQuantities
Type: object
Show Source
Nested Schema : sqsEstimationIndicators
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : badgedItem
Type: object
Show Source
Nested Schema : calculationGroup
Type: object
Show Source
Nested Schema : itemType
Type: object
Show Source
Nested Schema : servicePoint
Type: object
Show Source
Nested Schema : uom
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : calculationGroup
Type: object
Show Source
Nested Schema : calculationRule
Type: object
Show Source
Nested Schema : characteristicType
Type: object
Show Source
Nested Schema : characteristicValue
Type: object
Show Source
Nested Schema : factor
Type: object
Show Source
Nested Schema : measuringComponent
Type: object
Show Source
Nested Schema : servicePoint
Type: object
Show Source
Nested Schema : sqi
Type: object
Show Source
Nested Schema : tou
Type: object
Show Source
Nested Schema : touMap
Type: object
Show Source
Nested Schema : uom
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : sqi
Type: object
Show Source
Nested Schema : tou
Type: object
Show Source
Nested Schema : uom
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Value: -1.0E12
    Maximum Value: 1.0E12
    Applied Multiplier
    Example: 123.000000
  • calculationGroup
  • End Date/Time
  • Minimum Value: -9.999999999999998E9
    Maximum Value: 9.999999999999998E9
    End Measurement
    Example: 0.080000
  • Allowed Values: [ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
    Condition: * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPD
  • Minimum Value: -9.999999999999998E9
    Maximum Value: 9.999999999999998E9
    Final Quantity
    Example: 9.840000
  • finalSqi
  • finalTou
  • finalUom
  • Allowed Values: [ "+ ", "- ", "C ", "P " ]
    How To Use * `+ ` - Additive, * `- ` - Subtractive, * `C ` - Check, * `P ` - Peak
    Example: P
  • Allowed Values: [ "D1DP", "D1MP" ]
    Measures Peak Quantity * `D1DP` - No, * `D1MP` - Yes
    Example: D1DP
  • Maximum Length: 12
    Measuring Component ID
    Example: 658852900520
  • Minimum Value: -9.999999999999998E9
    Maximum Value: 9.999999999999998E9
    Quantity
    Example: 9.840000
  • Minimum Value: -999
    Maximum Value: 999
    Sequence
  • servicePoint
  • Allowed Values: [ "D1AD", "D1CK", "D1ST" ]
    Usage: * `D1AD` - Add, * `D1CK` - Exclude, * `D1ST` - Subtract
  • sqi
  • Defines the start date and time of the usage period.
    Example: 2013-01-02T00:00:00-08:00
  • Minimum Value: -9.999999999999998E9
    Maximum Value: 9.999999999999998E9
    Start Measurement
    Example: 0.000000
  • Allowed Values: [ "102000", "ZZ-test-mark1", "100000", "901000", "ZZBUG", "402000", "201000", "ZZ-500001", "501000", "ZZ-301024", "ZZ-301022", "101500", "ZZ-301501", "ZZ-401000", "ZZ-301515", "ZZ-301514", "ZZ-301513", "101000", "409000", "401000", "zz-test3", "ZZ-TestBug", "zz-test5", "ZZ-301031", "ZZ-301491", "100500", "ZZ-301511", "ZZ-TEST-AGAIN", "301000", "ZZ_Test211" ]
    Start Measurement Condition * `102000` - No Read - Disconnected, * `ZZ-test-mark1` - zz-test-mark1, * `100000` - No Read - System, * `901000` - Super, * `ZZBUG` - Override description, * `402000` - Office Estimate, * `201000` - Missing, * `ZZ-500001` - Prorated, * `501000` - Regular, * `ZZ-301024` - ZZ Estimate - Interval Interpolation, * `ZZ-301022` - ZZ Estimate - Interval Averaging, * `101500` - No Read - Outage Fill, * `ZZ-301501` - ZZ Scalar Calculation from Estimated Interval Read, * `ZZ-401000` - ZZ-External Estimate, * `ZZ-301515` - ZZ Prorated - Scalar Proration from Regular Read, * `ZZ-301514` - ZZ Prorated - Scalar Adjustment from Regular Interval, * `ZZ-301513` - ZZ Prorated - Interval Adjustment from Regular Scalar, * `101000` - No Read - Outage, * `409000` - Combined Quantity, * `401000` - External Estimate, * `zz-test3` - Override description, * `ZZ-TestBug` - ZZ-TestBug-Override description, * `zz-test5` - zz test 5, * `ZZ-301031` - ZZ Estimate - Int Adj From Scalar, * `ZZ-301491` - ZZ Estimate - Scalar Estimation, * `100500` - No Read - Field, * `ZZ-301511` - ZZ Scalar Proration from Estimation Read, * `ZZ-TEST-AGAIN` - ZZ-TEST ONLY, * `301000` - System Estimate, * `ZZ_Test211` - ZZ_Test211-UPD
    Example: 501000
  • tou
  • uom
  • Maximum Length: 30
    Usage calculation rules are standard and custom rules that perform calculations on measurement data to generate bill determinants.
    Example: ZZS-MRULGRP-SCALAR-RULE
  • Minimum Value: -999
    Maximum Value: 999
    Use percent
    Example: 100
Nested Schema : calculationGroup
Type: object
Show Source
Nested Schema : finalSqi
Type: object
Show Source
Nested Schema : finalTou
Type: object
Show Source
Nested Schema : finalUom
Type: object
Show Source
Nested Schema : servicePoint
Type: object
Show Source
Nested Schema : sqi
Type: object
Show Source
Nested Schema : tou
Type: object
Show Source
Nested Schema : uom
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