Oracle Utilities REST API for Metering and Customer Information

Billed Usage for SA

post

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

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":"The bill segment's service agreement unique identifier."
                    },
                    "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"
                    }
                }
            }
        }
    },
    "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":"The bill segment's service agreement unique identifier."
            },
            "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

endDate: string (date)

The end date for the service agreement.

Example: 2022-12-20
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

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "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"
        }
    }
}

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":"The bill segment's service agreement unique identifier."
                    },
                    "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"
                    }
                }
            }
        }
    },
    "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":"The bill segment's service agreement unique identifier."
            },
            "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

endDate: string (date)

The end date for the service agreement.

Example: 2022-12-20
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

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "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"
        }
    }
}

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":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"The bill segment's service agreement unique identifier."
                },
                "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"
                },
                "graphUnitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The unit of measure defined on the service agreement used to plot a graph of billed usage over time",
                    "example":"KWH"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"The type of service associated with the service agreement.",
                    "example":"W"
                },
                "currency":{
                    "type":"object",
                    "description":"Defines the currency in which the account's financial transactions are expressed.",
                    "properties":{
                        "currency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Defines the currency in which the account's financial transactions are expressed.",
                            "example":"USD"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "billSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "billSegmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"The system-assigned unique identifier of the bill segment."
                            },
                            "billDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The business date that was used when the bill was generated."
                            },
                            "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":"Indicates whether or not the usage value was estimated.",
                                "example":"true"
                            },
                            "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":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)"
                                        },
                                        "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"
                                        },
                                        "unitOfMeasure":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"The unit of measure of the bill segments's usage value.",
                                            "example":"KWH"
                                        },
                                        "timeOfUse":{
                                            "type":"string",
                                            "maxLength":30,
                                            "description":"The time-of-use classification of the bill segment's service quantity.",
                                            "example":"OFF"
                                        },
                                        "serviceQuantityIdentifer":{
                                            "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)"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BillUsagSA"
    }
}

Nested Schema : serviceAgreementDetails

Type: object

Show Source

billSegments: array billSegments
currency: object currency

Defines the currency in which the account's financial transactions are expressed.
endDate: string (date)

The end date for the service agreement.

Example: 2022-12-20
graphUnitOfMeasure: string

Maximum Length: 30

The unit of measure defined on the service agreement used to plot a graph of billed usage over time

Example: KWH
serviceAgreementId: string

Maximum Length: 10

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

Maximum Length: 80

The type of service associated with the service agreement.

Example: W
startDate: string (date)

The start date for the service agreement.

Example: 2022-12-20

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier."
        },
        "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"
        },
        "graphUnitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure defined on the service agreement used to plot a graph of billed usage over time",
            "example":"KWH"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"The type of service associated with the service agreement.",
            "example":"W"
        },
        "currency":{
            "type":"object",
            "description":"Defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billSegmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"The system-assigned unique identifier of the bill segment."
                    },
                    "billDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The business date that was used when the bill was generated."
                    },
                    "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":"Indicates whether or not the usage value was estimated.",
                        "example":"true"
                    },
                    "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":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)"
                                },
                                "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"
                                },
                                "unitOfMeasure":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The unit of measure of the bill segments's usage value.",
                                    "example":"KWH"
                                },
                                "timeOfUse":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"The time-of-use classification of the bill segment's service quantity.",
                                    "example":"OFF"
                                },
                                "serviceQuantityIdentifer":{
                                    "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)"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : billSegments

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billSegmentId":{
                "type":"string",
                "maxLength":12,
                "description":"The system-assigned unique identifier of the bill segment."
            },
            "billDate":{
                "type":"string",
                "format":"date",
                "description":"The business date that was used when the bill was generated."
            },
            "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":"Indicates whether or not the usage value was estimated.",
                "example":"true"
            },
            "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":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)"
                        },
                        "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"
                        },
                        "unitOfMeasure":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The unit of measure of the bill segments's usage value.",
                            "example":"KWH"
                        },
                        "timeOfUse":{
                            "type":"string",
                            "maxLength":30,
                            "description":"The time-of-use classification of the bill segment's service quantity.",
                            "example":"OFF"
                        },
                        "serviceQuantityIdentifer":{
                            "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)"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Defines the currency in which the account's financial transactions are expressed.

Show Source

_link: string

_link
currency: string

Maximum Length: 3

Defines the currency in which the account's financial transactions are expressed.

Example: USD

{
    "type":"object",
    "description":"Defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

billDate: string (date)

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

Maximum Length: 12

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

Indicates whether or not the usage value was estimated.

Example: true
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":"The system-assigned unique identifier of the bill segment."
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"The business date that was used when the bill was generated."
        },
        "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":"Indicates whether or not the usage value was estimated.",
            "example":"true"
        },
        "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":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)"
                    },
                    "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"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The unit of measure of the bill segments's usage value.",
                        "example":"KWH"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The time-of-use classification of the bill segment's service quantity.",
                        "example":"OFF"
                    },
                    "serviceQuantityIdentifer":{
                        "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)"
                    }
                }
            }
        }
    }
}

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)"
            },
            "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"
            },
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"The unit of measure of the bill segments's usage value.",
                "example":"KWH"
            },
            "timeOfUse":{
                "type":"string",
                "maxLength":30,
                "description":"The time-of-use classification of the bill segment's service quantity.",
                "example":"OFF"
            },
            "serviceQuantityIdentifer":{
                "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)"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

serviceQuantityIdentifer: 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)
timeOfUse: string

Maximum Length: 30

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

Example: OFF
unitOfMeasure: string

Maximum Length: 30

The unit of measure of the bill segments's usage value.

Example: KWH
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)"
        },
        "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"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"The unit of measure of the bill segments's usage value.",
            "example":"KWH"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"The time-of-use classification of the bill segment's service quantity.",
            "example":"OFF"
        },
        "serviceQuantityIdentifer":{
            "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)"
        }
    }
}

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