Oracle Utilities REST API for Metering and Customer Information

Single Service Usage Summary for a date range

post

https://server:port/spl/rest/apis/customer/usage/usageData/singleServiceSummary

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

billDate: string (date)

The business date that was used when the bill was generated.
drillDownAvailable: boolean

Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.

Example: true
endDate: string (date)

The end date for the service agreement.

Example: 2022-12-20
peakIndicator: boolean

Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.

Example: false
serviceAgreementId: string

Maximum Length: 10

The bill segment's service agreement unique identifier.
startDate: string (date)

The start date for the service agreement.

Example: 2022-12-20
timeScale: string

Allowed Values: [ "C1BP", "C1HR", "C1WK", "C1YR" ]

The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values. * `C1BP` - Bill Period View, * `C1HR` - Hourly View, * `C1WK` - Week View, * `C1YR` - Year View

Example: C1BP
unitOfMeasure: string

Maximum Length: 30

The unit of measure of the bill segments' service quantity.

Example: KWH

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "timeScale":{
            "type":"string",
            "enum":[
                "C1BP",
                "C1HR",
                "C1WK",
                "C1YR"
            ],
            "description":"The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values.\n* `C1BP` - Bill Period View,\n* `C1HR` - Hourly View,\n* `C1WK` - Week View,\n* `C1YR` - Year View",
            "example":"C1BP"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date for the service agreement.",
            "example":"2022-12-20"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The end date for the service agreement.",
            "example":"2022-12-20"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"The business date that was used when the bill was generated."
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments' service quantity.",
            "example":"KWH"
        },
        "peakIndicator":{
            "type":"boolean",
            "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
            "example":"false"
        },
        "drillDownAvailable":{
            "type":"boolean",
            "description":"Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.",
            "example":"true"
        }
    },
    "xml":{
        "name":"C1GetBiUsg"
    }
}

Root Schema : schema

Type: object

Show Source

billDate: string (date)

The business date that was used when the bill was generated.
drillDownAvailable: boolean

Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.

Example: true
endDate: string (date)

The end date for the service agreement.

Example: 2022-12-20
peakIndicator: boolean

Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.

Example: false
serviceAgreementId: string

Maximum Length: 10

The bill segment's service agreement unique identifier.
startDate: string (date)

The start date for the service agreement.

Example: 2022-12-20
timeScale: string

Allowed Values: [ "C1BP", "C1HR", "C1WK", "C1YR" ]

The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values. * `C1BP` - Bill Period View, * `C1HR` - Hourly View, * `C1WK` - Week View, * `C1YR` - Year View

Example: C1BP
unitOfMeasure: string

Maximum Length: 30

The unit of measure of the bill segments' service quantity.

Example: KWH

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "timeScale":{
            "type":"string",
            "enum":[
                "C1BP",
                "C1HR",
                "C1WK",
                "C1YR"
            ],
            "description":"The time scale definition defines the length of time covered by each usage group - ranging from the usage from a bill period down to hourly usage values.\n* `C1BP` - Bill Period View,\n* `C1HR` - Hourly View,\n* `C1WK` - Week View,\n* `C1YR` - Year View",
            "example":"C1BP"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date for the service agreement.",
            "example":"2022-12-20"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The end date for the service agreement.",
            "example":"2022-12-20"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"The business date that was used when the bill was generated."
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments' service quantity.",
            "example":"KWH"
        },
        "peakIndicator":{
            "type":"boolean",
            "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
            "example":"false"
        },
        "drillDownAvailable":{
            "type":"boolean",
            "description":"Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.",
            "example":"true"
        }
    },
    "xml":{
        "name":"C1GetBiUsg"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1GetBiUsg

Type: object

Show Source

drillDownAvailable: boolean

Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.

Example: true
peakIndicator: boolean

Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.

Example: false
serviceAgreementId: string

Maximum Length: 10

The bill segment's service agreement unique identifier.
timeZone: string

Maximum Length: 50

The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred.
unitOfMeasure: string

Maximum Length: 30

The unit of measure of the bill segments' service quantity.

Example: KWH
usageDetails: array usageDetails

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "timeZone":{
            "type":"string",
            "maxLength":50,
            "description":"The Olson timezone name as defined in the Utility's installation setting that indicates when the usage occurred."
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments' service quantity.",
            "example":"KWH"
        },
        "peakIndicator":{
            "type":"boolean",
            "description":"Indicates if the unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement.",
            "example":"false"
        },
        "drillDownAvailable":{
            "type":"boolean",
            "description":"Flag to indicate whether drill down to more granular usage values such as daily or hourly values are available. Drill Down Available is true only when SA type's Special Role Flag is 'BD' otherwise, false.",
            "example":"true"
        },
        "usageDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usagePeriod":{
                        "type":"object",
                        "properties":{
                            "group":{
                                "type":"string",
                                "maxLength":30,
                                "description":"The Usage Group is a label for the specific time period that has been summarized in the group",
                                "example":"2020-05-01T00:00:00-07:00"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The start datetime is the beginning point for the usage calculation in the group",
                                "example":"1998-07-31"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"The end datetime is the end point for the for a usage calculation in the group.",
                                "example":"1999-07-31"
                            },
                            "billDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The business date that was used when the bill was generated."
                            },
                            "usage":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "usageIdentifier":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                            "example":"KWH--(UOM-TOU-SQI)"
                                        },
                                        "tou":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"The time-of-use classification of the bill segment's service quantity.",
                                            "example":"OFF"
                                        },
                                        "sqi":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                            "example":"DAMT (Daily Amount)"
                                        },
                                        "usageValue":{
                                            "type":"number",
                                            "maximum":9999.999999,
                                            "minimum":0,
                                            "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                            "example":"31743.8"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1GetBiUsg"
    }
}

Nested Schema : usageDetails

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "usagePeriod":{
                "type":"object",
                "properties":{
                    "group":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The Usage Group is a label for the specific time period that has been summarized in the group",
                        "example":"2020-05-01T00:00:00-07:00"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The start datetime is the beginning point for the usage calculation in the group",
                        "example":"1998-07-31"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The end datetime is the end point for the for a usage calculation in the group.",
                        "example":"1999-07-31"
                    },
                    "billDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The business date that was used when the bill was generated."
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                    "example":"KWH--(UOM-TOU-SQI)"
                                },
                                "tou":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The time-of-use classification of the bill segment's service quantity.",
                                    "example":"OFF"
                                },
                                "sqi":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                    "example":"DAMT (Daily Amount)"
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":9999.999999,
                                    "minimum":0,
                                    "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                    "example":"31743.8"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

usagePeriod: object usagePeriod

{
    "type":"object",
    "properties":{
        "usagePeriod":{
            "type":"object",
            "properties":{
                "group":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Usage Group is a label for the specific time period that has been summarized in the group",
                    "example":"2020-05-01T00:00:00-07:00"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The start datetime is the beginning point for the usage calculation in the group",
                    "example":"1998-07-31"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The end datetime is the end point for the for a usage calculation in the group.",
                    "example":"1999-07-31"
                },
                "billDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The business date that was used when the bill was generated."
                },
                "usage":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "usageIdentifier":{
                                "type":"string",
                                "maxLength":100,
                                "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                                "example":"KWH--(UOM-TOU-SQI)"
                            },
                            "tou":{
                                "type":"string",
                                "maxLength":30,
                                "description":"The time-of-use classification of the bill segment's service quantity.",
                                "example":"OFF"
                            },
                            "sqi":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                                "example":"DAMT (Daily Amount)"
                            },
                            "usageValue":{
                                "type":"number",
                                "maximum":9999.999999,
                                "minimum":0,
                                "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                                "example":"31743.8"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : usagePeriod

Type: object

Show Source

billDate: string (date)

The business date that was used when the bill was generated.
endDateTime: string (date-time)

The end datetime is the end point for the for a usage calculation in the group.

Example: 1999-07-31
group: string

Maximum Length: 30

The Usage Group is a label for the specific time period that has been summarized in the group

Example: 2020-05-01T00:00:00-07:00
startDateTime: string (date-time)

The start datetime is the beginning point for the usage calculation in the group

Example: 1998-07-31
usage: array usage

{
    "type":"object",
    "properties":{
        "group":{
            "type":"string",
            "maxLength":30,
            "description":"The Usage Group is a label for the specific time period that has been summarized in the group",
            "example":"2020-05-01T00:00:00-07:00"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start datetime is the beginning point for the usage calculation in the group",
            "example":"1998-07-31"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end datetime is the end point for the for a usage calculation in the group.",
            "example":"1999-07-31"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"The business date that was used when the bill was generated."
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                        "example":"KWH--(UOM-TOU-SQI)"
                    },
                    "tou":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The time-of-use classification of the bill segment's service quantity.",
                        "example":"OFF"
                    },
                    "sqi":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                        "example":"DAMT (Daily Amount)"
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":9999.999999,
                        "minimum":0,
                        "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                        "example":"31743.8"
                    }
                }
            }
        }
    }
}

Nested Schema : usage

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "usageIdentifier":{
                "type":"string",
                "maxLength":100,
                "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
                "example":"KWH--(UOM-TOU-SQI)"
            },
            "tou":{
                "type":"string",
                "maxLength":30,
                "description":"The time-of-use classification of the bill segment's service quantity.",
                "example":"OFF"
            },
            "sqi":{
                "type":"string",
                "maxLength":30,
                "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
                "example":"DAMT (Daily Amount)"
            },
            "usageValue":{
                "type":"number",
                "maximum":9999.999999,
                "minimum":0,
                "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
                "example":"31743.8"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

sqi: string

Maximum Length: 30

Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.

Example: DAMT (Daily Amount)
tou: string

Maximum Length: 30

The time-of-use classification of the bill segment's service quantity.

Example: OFF
usageIdentifier: string

Maximum Length: 100

An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.

Example: KWH--(UOM-TOU-SQI)
usageValue: number

Minimum Value: 0

Maximum Value: 9999.999999

The total usage value. Refer to the defined unit of measure for complete context of this value.

Example: 31743.8

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.",
            "example":"KWH--(UOM-TOU-SQI)"
        },
        "tou":{
            "type":"string",
            "maxLength":30,
            "description":"The time-of-use classification of the bill segment's service quantity.",
            "example":"OFF"
        },
        "sqi":{
            "type":"string",
            "maxLength":30,
            "description":"Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.",
            "example":"DAMT (Daily Amount)"
        },
        "usageValue":{
            "type":"number",
            "maximum":9999.999999,
            "minimum":0,
            "description":"The total usage value. Refer to the defined unit of measure for complete context of this value.",
            "example":"31743.8"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}