Oracle Utilities REST API for Metering and Customer Information

Billed Usage for SA

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

filters: array filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"SA ID is the bill segment's service agreement."
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"SA start date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"SA end date"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BillUsagSA"
    }
}

Nested Schema : filters

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementId":{
                "type":"string",
                "maxLength":10,
                "description":"SA ID is the bill segment's service agreement."
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"SA start date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"SA end date"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

endDate: string (date)

SA end date
serviceAgreementId: string

Maximum Length: 10

SA ID is the bill segment's service agreement.
startDate: string (date)

SA start date

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"SA ID is the bill segment's service agreement."
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"SA start date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"SA end date"
        }
    }
}

Root Schema : schema

Type: object

Show Source

filters: array filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"SA ID is the bill segment's service agreement."
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"SA start date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"SA end date"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BillUsagSA"
    }
}

Nested Schema : filters

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreementId":{
                "type":"string",
                "maxLength":10,
                "description":"SA ID is the bill segment's service agreement."
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"SA start date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"SA end date"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

endDate: string (date)

SA end date
serviceAgreementId: string

Maximum Length: 10

SA ID is the bill segment's service agreement.
startDate: string (date)

SA start date

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"SA ID is the bill segment's service agreement."
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"SA start date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"SA end date"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1BillUsagSA

Type: object

Show Source

serviceAgreementDetails: object serviceAgreementDetails

{
    "type":"object",
    "properties":{
        "serviceAgreementDetails":{
            "type":"object",
            "properties":{
                "saId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"SA ID is the bill segment's service agreement."
                },
                "saStartDate":{
                    "type":"string",
                    "format":"date",
                    "description":"SA start date"
                },
                "saEndDate":{
                    "type":"string",
                    "format":"date",
                    "description":"SA end date"
                },
                "graphUnitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Unit of Measure",
                    "example":"KWH"
                },
                "serviceTypeCode":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"W"
                },
                "billSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billSegmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment."
                            },
                            "billDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The business date that was used when the bill batch generated the bill."
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.",
                                "example":"2020-01-01"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.",
                                "example":"2021-01-01"
                            },
                            "estimated":{
                                "type":"boolean",
                                "description":"A flag to indicate whether or not this value was estimated."
                            },
                            "totalAmount":{
                                "type":"number",
                                "description":"Sum of amounts from financial transactions for the bill's non-canceled segments."
                            },
                            "usage":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "usageIdentifier":{
                                            "type":"string",
                                            "maxLength":12,
                                            "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                                            "example":"KWH/-/-"
                                        },
                                        "usageValue":{
                                            "type":"number",
                                            "maximum":999999,
                                            "minimum":0,
                                            "description":"Usage Value",
                                            "example":"31743.8"
                                        },
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                                            "example":"KWH"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                                            "example":"OFF"
                                        },
                                        "serviceQuantityIdentifer":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                                            "example":"DAMT (Daily Amount)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BillUsagSA"
    }
}

Nested Schema : serviceAgreementDetails

Type: object

Show Source

billSegments: array billSegments
graphUnitOfMeasure: string

Maximum Length: 30

Unit of Measure

Example: KWH
saEndDate: string (date)

SA end date
saId: string

Maximum Length: 10

SA ID is the bill segment's service agreement.
saStartDate: string (date)

SA start date
serviceTypeCode: string

Maximum Length: 80

Service Type defines the type of service associated with the SA type.

Example: W

{
    "type":"object",
    "properties":{
        "saId":{
            "type":"string",
            "maxLength":10,
            "description":"SA ID is the bill segment's service agreement."
        },
        "saStartDate":{
            "type":"string",
            "format":"date",
            "description":"SA start date"
        },
        "saEndDate":{
            "type":"string",
            "format":"date",
            "description":"SA end date"
        },
        "graphUnitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure",
            "example":"KWH"
        },
        "serviceTypeCode":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"W"
        },
        "billSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billSegmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment."
                    },
                    "billDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The business date that was used when the bill batch generated the bill."
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.",
                        "example":"2020-01-01"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.",
                        "example":"2021-01-01"
                    },
                    "estimated":{
                        "type":"boolean",
                        "description":"A flag to indicate whether or not this value was estimated."
                    },
                    "totalAmount":{
                        "type":"number",
                        "description":"Sum of amounts from financial transactions for the bill's non-canceled segments."
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":12,
                                    "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                                    "example":"KWH/-/-"
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":999999,
                                    "minimum":0,
                                    "description":"Usage Value",
                                    "example":"31743.8"
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                                    "example":"KWH"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                                    "example":"OFF"
                                },
                                "serviceQuantityIdentifer":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                                    "example":"DAMT (Daily Amount)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : billSegments

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billSegmentId":{
                "type":"string",
                "maxLength":12,
                "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment."
            },
            "billDate":{
                "type":"string",
                "format":"date",
                "description":"The business date that was used when the bill batch generated the bill."
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.",
                "example":"2020-01-01"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.",
                "example":"2021-01-01"
            },
            "estimated":{
                "type":"boolean",
                "description":"A flag to indicate whether or not this value was estimated."
            },
            "totalAmount":{
                "type":"number",
                "description":"Sum of amounts from financial transactions for the bill's non-canceled segments."
            },
            "usage":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "usageIdentifier":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                            "example":"KWH/-/-"
                        },
                        "usageValue":{
                            "type":"number",
                            "maximum":999999,
                            "minimum":0,
                            "description":"Usage Value",
                            "example":"31743.8"
                        },
                        "unitOfMeasure":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                            "example":"KWH"
                        },
                        "timeOfUse":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                            "example":"OFF"
                        },
                        "serviceQuantityIdentifer":{
                            "type":"string",
                            "maxLength":30,
                            "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                            "example":"DAMT (Daily Amount)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

billDate: string (date)

The business date that was used when the bill batch generated the bill.
billSegmentId: string

Maximum Length: 12

Bill Segment ID is the system-assigned unique identifier of the bill segment.
endDate: string (date)

The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.

Example: 2021-01-01
estimated: boolean

A flag to indicate whether or not this value was estimated.
startDate: string (date)

The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.

Example: 2020-01-01
totalAmount: number

Sum of amounts from financial transactions for the bill's non-canceled segments.
usage: array usage

{
    "type":"object",
    "properties":{
        "billSegmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment."
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"The business date that was used when the bill batch generated the bill."
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.",
            "example":"2020-01-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.",
            "example":"2021-01-01"
        },
        "estimated":{
            "type":"boolean",
            "description":"A flag to indicate whether or not this value was estimated."
        },
        "totalAmount":{
            "type":"number",
            "description":"Sum of amounts from financial transactions for the bill's non-canceled segments."
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                        "example":"KWH/-/-"
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"Usage Value",
                        "example":"31743.8"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                        "example":"KWH"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                        "example":"OFF"
                    },
                    "serviceQuantityIdentifer":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                        "example":"DAMT (Daily Amount)"
                    }
                }
            }
        }
    }
}

Nested Schema : usage

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "usageIdentifier":{
                "type":"string",
                "maxLength":12,
                "description":"Usage Identifier (combination of UOM/TOU/SQI)",
                "example":"KWH/-/-"
            },
            "usageValue":{
                "type":"number",
                "maximum":999999,
                "minimum":0,
                "description":"Usage Value",
                "example":"31743.8"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
                "example":"KWH"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
                "example":"OFF"
            },
            "serviceQuantityIdentifer":{
                "type":"string",
                "maxLength":30,
                "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
                "example":"DAMT (Daily Amount)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

serviceQuantityIdentifer: string

Maximum Length: 30

SQI is the service quantity identifier of the bill segments's service quantity.

Example: DAMT (Daily Amount)
timeOfUse: string

Maximum Length: 30

Time of Use is the time-of-use of the bill segment's service quantity.

Example: OFF
unitOfMeasure: string

Maximum Length: 30

Unit of Measure is the unit of measure of the bill segments's service quantity.

Example: KWH
usageIdentifier: string

Maximum Length: 12

Usage Identifier (combination of UOM/TOU/SQI)

Example: KWH/-/-
usageValue: number

Minimum Value: 0

Maximum Value: 999999

Usage Value

Example: 31743.8

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":12,
            "description":"Usage Identifier (combination of UOM/TOU/SQI)",
            "example":"KWH/-/-"
        },
        "usageValue":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Usage Value",
            "example":"31743.8"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure is the unit of measure of the bill segments's service quantity.",
            "example":"KWH"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use is the time-of-use of the bill segment's service quantity.",
            "example":"OFF"
        },
        "serviceQuantityIdentifer":{
            "type":"string",
            "maxLength":30,
            "description":"SQI is the service quantity identifier of the bill segments's service quantity.",
            "example":"DAMT (Daily Amount)"
        }
    }
}

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