Oracle Utilities REST API for Metering and Customer Information

Retrieve SP Usage

post

/rest/apis/customer/v-model/servicePointsCommon/servicePointUsage

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

endDate: string (date)

Optional end date for requesting the service point usage data.

Example: 2024-02-20
httpMethod: string

Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put
spId: string

Maximum Length: 10

Service Point ID
startDate: string (date)

Optional start date for requesting the service point usage data.

Example: 2023-01-10
timeScale: string

Allowed Values: [ "C1YR", "X1DY", "X1MO" ]

Time scale of usage data to that can be for a Year (monthly data), Month (daily data), or Day (hourly data). * `C1YR` - View Year, * `X1DY` - View Day, * `X1MO` - View Month

Example: C1MO
unitOfMeasure: string

Maximum Length: 30

The input unit of measure of the usage data requested.

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method:\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put"
        },
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "timeScale":{
            "type":"string",
            "enum":[
                "C1YR",
                "X1DY",
                "X1MO"
            ],
            "description":"Time scale of usage data to that can be for a Year (monthly data), Month (daily data), or Day (hourly data).\n* `C1YR` - View Year,\n* `X1DY` - View Day,\n* `X1MO` - View Month",
            "example":"C1MO"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Optional start date for requesting the service point usage data.",
            "example":"2023-01-10"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"Optional end date for requesting the service point usage data.",
            "example":"2024-02-20"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The input unit of measure of the usage data requested."
        }
    },
    "xml":{
        "name":"C1RetSPUsage"
    }
}

Root Schema : schema

Type: object

Show Source

endDate: string (date)

Optional end date for requesting the service point usage data.

Example: 2024-02-20
httpMethod: string

Allowed Values: [ "DELT", "GET ", "POST", "PTCH", "PUT " ]

HTTP Method: * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - Put
spId: string

Maximum Length: 10

Service Point ID
startDate: string (date)

Optional start date for requesting the service point usage data.

Example: 2023-01-10
timeScale: string

Allowed Values: [ "C1YR", "X1DY", "X1MO" ]

Time scale of usage data to that can be for a Year (monthly data), Month (daily data), or Day (hourly data). * `C1YR` - View Year, * `X1DY` - View Day, * `X1MO` - View Month

Example: C1MO
unitOfMeasure: string

Maximum Length: 30

The input unit of measure of the usage data requested.

{
    "type":"object",
    "properties":{
        "httpMethod":{
            "type":"string",
            "enum":[
                "DELT",
                "GET ",
                "POST",
                "PTCH",
                "PUT "
            ],
            "description":"HTTP Method:\n* `DELT` - Delete,\n* `GET ` - Get,\n* `POST` - Post,\n* `PTCH` - Patch,\n* `PUT ` - Put"
        },
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "timeScale":{
            "type":"string",
            "enum":[
                "C1YR",
                "X1DY",
                "X1MO"
            ],
            "description":"Time scale of usage data to that can be for a Year (monthly data), Month (daily data), or Day (hourly data).\n* `C1YR` - View Year,\n* `X1DY` - View Day,\n* `X1MO` - View Month",
            "example":"C1MO"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Optional start date for requesting the service point usage data.",
            "example":"2023-01-10"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"Optional end date for requesting the service point usage data.",
            "example":"2024-02-20"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The input unit of measure of the usage data requested."
        }
    },
    "xml":{
        "name":"C1RetSPUsage"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1RetSPUsage

Type: object

Show Source

endDate: string (date)

Optional end date for requesting the service point usage data.

Example: 2024-02-20
peakIndicator: boolean

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

Maximum Length: 400

Error Message
spId: string

Maximum Length: 10

Service Point ID
startDate: string (date)

Optional start date for requesting the service point usage data.

Example: 2023-01-10
timeZone: string

Maximum Length: 50

The description for the time zone that is displayed to customers.

Example: US/Pacific
unitOfMeasure: string

Maximum Length: 30

The input unit of measure of the usage data requested.
usageDetails: array usageDetails

{
    "type":"object",
    "properties":{
        "spId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Point ID"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Optional start date for requesting the service point usage data.",
            "example":"2023-01-10"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"Optional end date for requesting the service point usage data.",
            "example":"2024-02-20"
        },
        "timeZone":{
            "type":"string",
            "maxLength":50,
            "description":"The description for the time zone that is displayed to customers.",
            "example":"US/Pacific"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The input unit of measure of the usage data requested."
        },
        "peakIndicator":{
            "type":"boolean",
            "description":"Indicates if the requested unit of measure is one that measures peak consumption. A value of true indicates peak consumption measurement."
        },
        "resultMessage":{
            "type":"string",
            "maxLength":400,
            "description":"Error Message"
        },
        "usageDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usagePeriod":{
                        "type":"object",
                        "properties":{
                            "group":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Group"
                            },
                            "startDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Start date time of the usage period.",
                                "example":"2020-04-30T00:00:00-07:00"
                            },
                            "endDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"End date time of the usage period.",
                                "example":"2020-05-01T00:00:00-07:00"
                            },
                            "drillDownAvailable":{
                                "type":"boolean",
                                "description":"Drill Down Available is true if the meter transmits interval data to allow for smaller time scales.",
                                "example":"true"
                            },
                            "usage":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "usageIdentifier":{
                                            "type":"string",
                                            "maxLength":100,
                                            "description":"An identifier for the usage value, 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-ON-"
                                        },
                                        "tou":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"The time-of-use classification of the usage value.",
                                            "example":"ON"
                                        },
                                        "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."
                                        },
                                        "usageValue":{
                                            "type":"number",
                                            "maximum":9999.999999,
                                            "minimum":0,
                                            "description":"The usage value for the corresponding identifier.",
                                            "example":"7.75"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1RetSPUsage"
    }
}

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":"Group"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Start date time of the usage period.",
                        "example":"2020-04-30T00:00:00-07:00"
                    },
                    "endDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"End date time of the usage period.",
                        "example":"2020-05-01T00:00:00-07:00"
                    },
                    "drillDownAvailable":{
                        "type":"boolean",
                        "description":"Drill Down Available is true if the meter transmits interval data to allow for smaller time scales.",
                        "example":"true"
                    },
                    "usage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "usageIdentifier":{
                                    "type":"string",
                                    "maxLength":100,
                                    "description":"An identifier for the usage value, 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-ON-"
                                },
                                "tou":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The time-of-use classification of the usage value.",
                                    "example":"ON"
                                },
                                "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."
                                },
                                "usageValue":{
                                    "type":"number",
                                    "maximum":9999.999999,
                                    "minimum":0,
                                    "description":"The usage value for the corresponding identifier.",
                                    "example":"7.75"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

usagePeriod: object usagePeriod

{
    "type":"object",
    "properties":{
        "usagePeriod":{
            "type":"object",
            "properties":{
                "group":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Group"
                },
                "startDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Start date time of the usage period.",
                    "example":"2020-04-30T00:00:00-07:00"
                },
                "endDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"End date time of the usage period.",
                    "example":"2020-05-01T00:00:00-07:00"
                },
                "drillDownAvailable":{
                    "type":"boolean",
                    "description":"Drill Down Available is true if the meter transmits interval data to allow for smaller time scales.",
                    "example":"true"
                },
                "usage":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "usageIdentifier":{
                                "type":"string",
                                "maxLength":100,
                                "description":"An identifier for the usage value, 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-ON-"
                            },
                            "tou":{
                                "type":"string",
                                "maxLength":30,
                                "description":"The time-of-use classification of the usage value.",
                                "example":"ON"
                            },
                            "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."
                            },
                            "usageValue":{
                                "type":"number",
                                "maximum":9999.999999,
                                "minimum":0,
                                "description":"The usage value for the corresponding identifier.",
                                "example":"7.75"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : usagePeriod

Type: object

Show Source

drillDownAvailable: boolean

Drill Down Available is true if the meter transmits interval data to allow for smaller time scales.

Example: true
endDateTime: string (date-time)

End date time of the usage period.

Example: 2020-05-01T00:00:00-07:00
group: string

Maximum Length: 30

Group
startDateTime: string (date-time)

Start date time of the usage period.

Example: 2020-04-30T00:00:00-07:00
usage: array usage

{
    "type":"object",
    "properties":{
        "group":{
            "type":"string",
            "maxLength":30,
            "description":"Group"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Start date time of the usage period.",
            "example":"2020-04-30T00:00:00-07:00"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"End date time of the usage period.",
            "example":"2020-05-01T00:00:00-07:00"
        },
        "drillDownAvailable":{
            "type":"boolean",
            "description":"Drill Down Available is true if the meter transmits interval data to allow for smaller time scales.",
            "example":"true"
        },
        "usage":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "usageIdentifier":{
                        "type":"string",
                        "maxLength":100,
                        "description":"An identifier for the usage value, 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-ON-"
                    },
                    "tou":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The time-of-use classification of the usage value.",
                        "example":"ON"
                    },
                    "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."
                    },
                    "usageValue":{
                        "type":"number",
                        "maximum":9999.999999,
                        "minimum":0,
                        "description":"The usage value for the corresponding identifier.",
                        "example":"7.75"
                    }
                }
            }
        }
    }
}

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 usage value, 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-ON-"
            },
            "tou":{
                "type":"string",
                "maxLength":30,
                "description":"The time-of-use classification of the usage value.",
                "example":"ON"
            },
            "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."
            },
            "usageValue":{
                "type":"number",
                "maximum":9999.999999,
                "minimum":0,
                "description":"The usage value for the corresponding identifier.",
                "example":"7.75"
            }
        }
    }
}

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.
tou: string

Maximum Length: 30

The time-of-use classification of the usage value.

Example: ON
usageIdentifier: string

Maximum Length: 100

An identifier for the usage value, 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-ON-
usageValue: number

Minimum Value: 0

Maximum Value: 9999.999999

The usage value for the corresponding identifier.

Example: 7.75

{
    "type":"object",
    "properties":{
        "usageIdentifier":{
            "type":"string",
            "maxLength":100,
            "description":"An identifier for the usage value, 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-ON-"
        },
        "tou":{
            "type":"string",
            "maxLength":30,
            "description":"The time-of-use classification of the usage value.",
            "example":"ON"
        },
        "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."
        },
        "usageValue":{
            "type":"number",
            "maximum":9999.999999,
            "minimum":0,
            "description":"The usage value for the corresponding identifier.",
            "example":"7.75"
        }
    }
}

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