Action Usage Transaction Service
patch
/rest/apis/meter/usage/usageTransactions/{usageTransactionId}/lifecycle
This operation updates the Usage Transaction status for the provided usageTransactionId.
Request
Path Parameters
-
usageTransactionId(required): string
Usage Transaction ID is a system assigned random number that stays with a usage transaction record.Example:
05458709929330
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
action: string
Allowed Values:
[ "D1CA", "D1DD", "D1OE", "D1ST" ]
Usage Transaction Web Service Action: * `D1CA` - Calculate, * `D1DD` - Discarded, * `D1OE` - Override Exception, * `D1ST` - Sent
Root Schema : schema
Type:
Show Source
object
-
action: string
Allowed Values:
[ "D1CA", "D1DD", "D1OE", "D1ST" ]
Usage Transaction Web Service Action: * `D1CA` - Calculate, * `D1DD` - Discarded, * `D1OE` - Override Exception, * `D1ST` - Sent
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1ActUsgTran
Type:
Show Source
object
-
action: string
Allowed Values:
[ "D1CA", "D1DD", "D1OE", "D1ST" ]
Usage Transaction Web Service Action: * `D1CA` - Calculate, * `D1DD` - Discarded, * `D1OE` - Override Exception, * `D1ST` - Sent -
businessObject: string
Maximum Length:
30
Business Object -
nextActions: array
nextActions
-
status: string
Maximum Length:
12
Status -
statusReason: string
Maximum Length:
30
Status Reason -
statusUpdateDateTime: string
(date-time)
Status Date/Time
-
usageTransaction: object
usageTransaction
Nested Schema : usageTransaction
Type:
Show Source
object
-
_link: string
_link
-
usageTransactionId: string
Maximum Length:
14
Usage Transaction ID is a system assigned random number that stays with a usage transaction record.Example:05458709929330
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "D1CA", "D1DD", "D1OE", "D1ST" ]
Usage Transaction Web Service Action: * `D1CA` - Calculate, * `D1DD` - Discarded, * `D1OE` - Override Exception, * `D1ST` - Sent
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.