Oracle Utilities REST API for Metering and Customer Information

Get Overdue Process

get

https://server:port/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}

Request

Path Parameters

overdueProcessId(required): string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1OverduePro

Type: object

Show Source

_self: string

_self
account: object account
baseDate: string (date)

Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.

Example: 2004-03-01
collectingOn: object collectingOn
currency: string

Maximum Length: 3

Currency Code
events: object events
longComments: string

Maximum Length: 2000

Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive.
name: string

(name)
overdueProcessId: string

Maximum Length: 12

Overdue Process ID is the system-assigned unique identifier of the process.c

Example: 460352888888
overdueProcessTemplate: object overdueProcessTemplate

Overdue Process Template defines the template that was used to create the overdue process's events.
startDateTime: string (date-time)

Create Date/Time defines the creation date/time of the cut process.

Example: 2005-04-18T07:50:51-04:00
status: string

Allowed Values: [ "10 ", "20 " ]

Overdue Process Status defines the state of the overdue process. * `10 ` - Active, * `20 ` - Inactive

Example: 20
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "name":{
            "type":"string",
            "description":"(name)"
        },
        "overdueProcessId":{
            "type":"string",
            "maxLength":12,
            "description":"Overdue Process ID is the system-assigned unique identifier of the process.c",
            "example":"460352888888"
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Overdue Process Status defines the state of the overdue process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "overdueProcessTemplate":{
            "type":"object",
            "description":"Overdue Process Template defines the template that was used to create the overdue process's events.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "overdueProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Overdue Process Template defines the template that was used to create the overdue process's events.",
                    "example":"RISKY"
                }
            }
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the creation date/time of the cut process.",
            "example":"2005-04-18T07:50:51-04:00"
        },
        "longComments":{
            "type":"string",
            "maxLength":2000,
            "description":"Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive."
        },
        "baseDate":{
            "type":"string",
            "format":"date",
            "description":"Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.",
            "example":"2004-03-01"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "status":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
                            },
                            "overdueEventTypeCode":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "overdueEventTypeCode":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Overdue Event Type"
                                    }
                                }
                            },
                            "dependOnOtherEvents":{
                                "type":"boolean",
                                "description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.",
                                "example":"false"
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                                "example":"2005-04-19"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "eventDependencies":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence Number",
                                                    "example":"10"
                                                },
                                                "dependentOnSequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                                                    "example":"10"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "collectingOn":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "originalAmount":{
                                "type":"number",
                                "description":"Original Amount"
                            },
                            "unpaidAmt":{
                                "type":"number",
                                "description":"Unpaid Amount"
                            },
                            "overdueBillId":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "overdueBillIdFkChar":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Characteristic Value FK 2"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OverduePro"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : collectingOn

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "originalAmount":{
                        "type":"number",
                        "description":"Original Amount"
                    },
                    "unpaidAmt":{
                        "type":"number",
                        "description":"Unpaid Amount"
                    },
                    "overdueBillId":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "overdueBillIdFkChar":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Characteristic Value FK 2"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : events

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
                    },
                    "overdueEventTypeCode":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "overdueEventTypeCode":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Overdue Event Type"
                            }
                        }
                    },
                    "dependOnOtherEvents":{
                        "type":"boolean",
                        "description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.",
                        "example":"false"
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                        "example":"2005-04-19"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "eventDependencies":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence Number",
                                            "example":"10"
                                        },
                                        "dependentOnSequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                                            "example":"10"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : overdueProcessTemplate

Type: object

Overdue Process Template defines the template that was used to create the overdue process's events.

Show Source

_link: string

_link
overdueProcessTemplate: string

Maximum Length: 12

Overdue Process Template defines the template that was used to create the overdue process's events.

Example: RISKY

{
    "type":"object",
    "description":"Overdue Process Template defines the template that was used to create the overdue process's events.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "overdueProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Overdue Process Template defines the template that was used to create the overdue process's events.",
            "example":"RISKY"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "originalAmount":{
                "type":"number",
                "description":"Original Amount"
            },
            "unpaidAmt":{
                "type":"number",
                "description":"Unpaid Amount"
            },
            "overdueBillId":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "overdueBillIdFkChar":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Characteristic Value FK 2"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

originalAmount: number

Original Amount
overdueBillId: object overdueBillId
unpaidAmt: number

Unpaid Amount
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "originalAmount":{
            "type":"number",
            "description":"Original Amount"
        },
        "unpaidAmt":{
            "type":"number",
            "description":"Unpaid Amount"
        },
        "overdueBillId":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "overdueBillIdFkChar":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Characteristic Value FK 2"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : overdueBillId

Type: object

Show Source

_link: string

_link
overdueBillIdFkChar: string

Maximum Length: 50

Characteristic Value FK 2

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "overdueBillIdFkChar":{
            "type":"string",
            "maxLength":50,
            "description":"Characteristic Value FK 2"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "status":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  "
                ],
                "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
            },
            "overdueEventTypeCode":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "overdueEventTypeCode":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Overdue Event Type"
                    }
                }
            },
            "dependOnOtherEvents":{
                "type":"boolean",
                "description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.",
                "example":"false"
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
                "example":"2005-04-19"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "eventDependencies":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence Number",
                                    "example":"10"
                                },
                                "dependentOnSequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                                    "example":"10"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

dependOnOtherEvents: boolean

If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.

Example: false
eventDependencies: object eventDependencies
eventSequence: number

Minimum Value: -999

Maximum Value: 999

Event Sequence is the unique identifier of the event.

Example: 10
overdueEventTypeCode: object overdueEventTypeCode
status: string

Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

Event Status: * `10 ` - Pending, * `20 ` - Waiting, * `30 ` - Completed, * `40 ` - Canceled
triggerDate: string (date)

If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.

Example: 2005-04-19
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "status":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Event Status:\n* `10  ` - Pending,\n* `20  ` - Waiting,\n* `30  ` - Completed,\n* `40  ` - Canceled"
        },
        "overdueEventTypeCode":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "overdueEventTypeCode":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Overdue Event Type"
                }
            }
        },
        "dependOnOtherEvents":{
            "type":"boolean",
            "description":"If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.",
            "example":"false"
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.",
            "example":"2005-04-19"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "eventDependencies":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence Number",
                                "example":"10"
                            },
                            "dependentOnSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                                "example":"10"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventDependencies

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence Number",
                        "example":"10"
                    },
                    "dependentOnSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                        "example":"10"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : overdueEventTypeCode

Type: object

Show Source

_link: string

_link
overdueEventTypeCode: string

Maximum Length: 12

Overdue Event Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "overdueEventTypeCode":{
            "type":"string",
            "maxLength":12,
            "description":"Overdue Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence Number",
                "example":"10"
            },
            "dependentOnSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
                "example":"10"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

dependentOnSequence: number

Minimum Value: -999

Maximum Value: 999

When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends.

Example: 10
sequence: number

Minimum Value: -999

Maximum Value: 999

Sequence Number

Example: 10
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence Number",
            "example":"10"
        },
        "dependentOnSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"When Dependent on Other Events is turned on, the Dependent on Sequence field  defines the event sequence number on which this event depends.",
            "example":"10"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

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