Jump to

• Request
• Response

Search Outage Events

post

/rest/apis/customer/service/outageEvent/search

This operation returns outage events for a given account and person.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"An optional input filter to find outage events for the Person ID."
                },
                "includeRecentlyRestored":{
                    "type":"boolean",
                    "description":"This field indicates if recently restored outage events should be included in the results."
                }
            }
        }
    },
    "xml":{
        "name":"C1OutagSerch"
    }
}

Nested Schema : filters

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• includeRecentlyRestored: boolean
  This field indicates if recently restored outage events should be included in the results.
• personId: string
  Maximum Length: 10

  An optional input filter to find outage events for the Person ID.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"An optional input filter to find outage events for the Person ID."
        },
        "includeRecentlyRestored":{
            "type":"boolean",
            "description":"This field indicates if recently restored outage events should be included in the results."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filters: object filters

{
    "type":"object",
    "properties":{
        "filters":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "personId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"An optional input filter to find outage events for the Person ID."
                },
                "includeRecentlyRestored":{
                    "type":"boolean",
                    "description":"This field indicates if recently restored outage events should be included in the results."
                }
            }
        }
    },
    "xml":{
        "name":"C1OutagSerch"
    }
}

Nested Schema : filters

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• includeRecentlyRestored: boolean
  This field indicates if recently restored outage events should be included in the results.
• personId: string
  Maximum Length: 10

  An optional input filter to find outage events for the Person ID.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"An optional input filter to find outage events for the Person ID."
        },
        "includeRecentlyRestored":{
            "type":"boolean",
            "description":"This field indicates if recently restored outage events should be included in the results."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1OutagSerch

Type: object

Show Source

• outageEvents: array outageEvents
• standardBaseTimeZoneName: string
  Maximum Length: 50

  The name of the time zone that is displayed to customers.

  Example: US/Pacific

{
    "type":"object",
    "properties":{
        "standardBaseTimeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"The name of the time zone that is displayed to customers.",
            "example":"US/Pacific"
        },
        "outageEvents":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "outageStatusType":{
                        "type":"string",
                        "enum":[
                            "C1AC",
                            "C1RR",
                            "C1SC"
                        ],
                        "description":"This field indicates if outage status is active or scheduled.\n* `C1AC` - Active,\n* `C1RR` - Recently Restored,\n* `C1SC` - Scheduled",
                        "example":"C1AC"
                    },
                    "outageEventId":{
                        "type":"string",
                        "maxLength":14,
                        "description":"The unique system generated primary key of the outage event record."
                    },
                    "externalOutageId":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The unique identifier of the outage event in the outage management system.",
                        "example":"200234"
                    },
                    "externalSystem":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an external system record.",
                        "example":"CCB-NMS integration"
                    },
                    "startDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The recorded start date and time of the outage event.",
                        "example":"2025-02-06T02:00:00-08:00"
                    },
                    "estimatedRestorationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The estimated restoration time of the outage event.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "completionDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The completed restoration or cancellation time of the outage event.",
                        "example":"2025-02-07T12:00:00-08:00"
                    },
                    "updateDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"The last updated date and time of the outage event."
                    },
                    "outageType":{
                        "type":"string",
                        "enum":[
                            "C1PL",
                            "C1UP"
                        ],
                        "description":"The Outage Type specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                        "example":"C1PL"
                    },
                    "primaryCauseDescription":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The language description for the primary cause of the outage event if available from the outage system. Typically, values can be selected from a configured list such as weather, environment, and so on.",
                        "example":"Trouble Call"
                    },
                    "eventState":{
                        "type":"string",
                        "enum":[
                        ],
                        "description":"The external outage management system sends the event state, which is mapped to a customizable lookup value. If the value exceeds four characters, the service uses the Java name attribute for mapping.\n",
                        "example":"NEW"
                    },
                    "eventStateDescription":{
                        "type":"string",
                        "maxLength":256,
                        "description":"The description for outage event status values available from the outage system.",
                        "example":"New unacknowledged event"
                    },
                    "locations":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "accountId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"Account ID"
                                },
                                "accountName":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The Account Name stored as a characteristic."
                                },
                                "premiseId":{
                                    "type":"string",
                                    "maxLength":10,
                                    "description":"The Premise ID associated with a service disruption caused by the outage event."
                                },
                                "premiseInfo":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"The information string for the premise that is used in the application.  The content is controlled by a plug-in algorithm on the installation record."
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1OutagSerch"
    }
}

Nested Schema : outageEvents

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "outageStatusType":{
                "type":"string",
                "enum":[
                    "C1AC",
                    "C1RR",
                    "C1SC"
                ],
                "description":"This field indicates if outage status is active or scheduled.\n* `C1AC` - Active,\n* `C1RR` - Recently Restored,\n* `C1SC` - Scheduled",
                "example":"C1AC"
            },
            "outageEventId":{
                "type":"string",
                "maxLength":14,
                "description":"The unique system generated primary key of the outage event record."
            },
            "externalOutageId":{
                "type":"string",
                "maxLength":254,
                "description":"The unique identifier of the outage event in the outage management system.",
                "example":"200234"
            },
            "externalSystem":{
                "type":"string",
                "maxLength":30,
                "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an external system record.",
                "example":"CCB-NMS integration"
            },
            "startDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The recorded start date and time of the outage event.",
                "example":"2025-02-06T02:00:00-08:00"
            },
            "estimatedRestorationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The estimated restoration time of the outage event.",
                "example":"2025-02-07T12:00:00-08:00"
            },
            "completionDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The completed restoration or cancellation time of the outage event.",
                "example":"2025-02-07T12:00:00-08:00"
            },
            "updateDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"The last updated date and time of the outage event."
            },
            "outageType":{
                "type":"string",
                "enum":[
                    "C1PL",
                    "C1UP"
                ],
                "description":"The Outage Type specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
                "example":"C1PL"
            },
            "primaryCauseDescription":{
                "type":"string",
                "maxLength":254,
                "description":"The language description for the primary cause of the outage event if available from the outage system. Typically, values can be selected from a configured list such as weather, environment, and so on.",
                "example":"Trouble Call"
            },
            "eventState":{
                "type":"string",
                "enum":[
                ],
                "description":"The external outage management system sends the event state, which is mapped to a customizable lookup value. If the value exceeds four characters, the service uses the Java name attribute for mapping.\n",
                "example":"NEW"
            },
            "eventStateDescription":{
                "type":"string",
                "maxLength":256,
                "description":"The description for outage event status values available from the outage system.",
                "example":"New unacknowledged event"
            },
            "locations":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "accountId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"Account ID"
                        },
                        "accountName":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The Account Name stored as a characteristic."
                        },
                        "premiseId":{
                            "type":"string",
                            "maxLength":10,
                            "description":"The Premise ID associated with a service disruption caused by the outage event."
                        },
                        "premiseInfo":{
                            "type":"string",
                            "maxLength":254,
                            "description":"The information string for the premise that is used in the application.  The content is controlled by a plug-in algorithm on the installation record."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• completionDateTime: string (date-time)
  The completed restoration or cancellation time of the outage event.

  Example: 2025-02-07T12:00:00-08:00
• estimatedRestorationDateTime: string (date-time)
  The estimated restoration time of the outage event.

  Example: 2025-02-07T12:00:00-08:00
• eventState: string
  The external outage management system sends the event state, which is mapped to a customizable lookup value. If the value exceeds four characters, the service uses the Java name attribute for mapping.

  Example: NEW
• eventStateDescription: string
  Maximum Length: 256

  The description for outage event status values available from the outage system.

  Example: New unacknowledged event
• externalOutageId: string
  Maximum Length: 254

  The unique identifier of the outage event in the outage management system.

  Example: 200234
• externalSystem: string
  Maximum Length: 30

  The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an external system record.

  Example: CCB-NMS integration
• locations: array locations
• outageEventId: string
  Maximum Length: 14

  The unique system generated primary key of the outage event record.
• outageStatusType: string
  Allowed Values: [ "C1AC", "C1RR", "C1SC" ]

  This field indicates if outage status is active or scheduled. * `C1AC` - Active, * `C1RR` - Recently Restored, * `C1SC` - Scheduled

  Example: C1AC
• outageType: string
  Allowed Values: [ "C1PL", "C1UP" ]

  The Outage Type specifies whether the outage was planned or not. * `C1PL` - Planned, * `C1UP` - Unplanned

  Example: C1PL
• primaryCauseDescription: string
  Maximum Length: 254

  The language description for the primary cause of the outage event if available from the outage system. Typically, values can be selected from a configured list such as weather, environment, and so on.

  Example: Trouble Call
• startDateTime: string (date-time)
  The recorded start date and time of the outage event.

  Example: 2025-02-06T02:00:00-08:00
• updateDateTime: string (date-time)
  The last updated date and time of the outage event.

{
    "type":"object",
    "properties":{
        "outageStatusType":{
            "type":"string",
            "enum":[
                "C1AC",
                "C1RR",
                "C1SC"
            ],
            "description":"This field indicates if outage status is active or scheduled.\n* `C1AC` - Active,\n* `C1RR` - Recently Restored,\n* `C1SC` - Scheduled",
            "example":"C1AC"
        },
        "outageEventId":{
            "type":"string",
            "maxLength":14,
            "description":"The unique system generated primary key of the outage event record."
        },
        "externalOutageId":{
            "type":"string",
            "maxLength":254,
            "description":"The unique identifier of the outage event in the outage management system.",
            "example":"200234"
        },
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"The unique identifier of the outage management system reporting the outage information. This should be a valid reference to an external system record.",
            "example":"CCB-NMS integration"
        },
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The recorded start date and time of the outage event.",
            "example":"2025-02-06T02:00:00-08:00"
        },
        "estimatedRestorationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The estimated restoration time of the outage event.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "completionDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The completed restoration or cancellation time of the outage event.",
            "example":"2025-02-07T12:00:00-08:00"
        },
        "updateDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The last updated date and time of the outage event."
        },
        "outageType":{
            "type":"string",
            "enum":[
                "C1PL",
                "C1UP"
            ],
            "description":"The Outage Type specifies whether the outage was planned or not.\n* `C1PL` - Planned,\n* `C1UP` - Unplanned",
            "example":"C1PL"
        },
        "primaryCauseDescription":{
            "type":"string",
            "maxLength":254,
            "description":"The language description for the primary cause of the outage event if available from the outage system. Typically, values can be selected from a configured list such as weather, environment, and so on.",
            "example":"Trouble Call"
        },
        "eventState":{
            "type":"string",
            "enum":[
            ],
            "description":"The external outage management system sends the event state, which is mapped to a customizable lookup value. If the value exceeds four characters, the service uses the Java name attribute for mapping.\n",
            "example":"NEW"
        },
        "eventStateDescription":{
            "type":"string",
            "maxLength":256,
            "description":"The description for outage event status values available from the outage system.",
            "example":"New unacknowledged event"
        },
        "locations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    },
                    "accountName":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The Account Name stored as a characteristic."
                    },
                    "premiseId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"The Premise ID associated with a service disruption caused by the outage event."
                    },
                    "premiseInfo":{
                        "type":"string",
                        "maxLength":254,
                        "description":"The information string for the premise that is used in the application.  The content is controlled by a plug-in algorithm on the installation record."
                    }
                }
            }
        }
    }
}

Nested Schema : locations

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID"
            },
            "accountName":{
                "type":"string",
                "maxLength":254,
                "description":"The Account Name stored as a characteristic."
            },
            "premiseId":{
                "type":"string",
                "maxLength":10,
                "description":"The Premise ID associated with a service disruption caused by the outage event."
            },
            "premiseInfo":{
                "type":"string",
                "maxLength":254,
                "description":"The information string for the premise that is used in the application.  The content is controlled by a plug-in algorithm on the installation record."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• accountName: string
  Maximum Length: 254

  The Account Name stored as a characteristic.
• premiseId: string
  Maximum Length: 10

  The Premise ID associated with a service disruption caused by the outage event.
• premiseInfo: string
  Maximum Length: 254

  The information string for the premise that is used in the application. The content is controlled by a plug-in algorithm on the installation record.

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "accountName":{
            "type":"string",
            "maxLength":254,
            "description":"The Account Name stored as a characteristic."
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"The Premise ID associated with a service disruption caused by the outage event."
        },
        "premiseInfo":{
            "type":"string",
            "maxLength":254,
            "description":"The information string for the premise that is used in the application.  The content is controlled by a plug-in algorithm on the installation record."
        }
    }
}

400 Response

Bad Request

Body ()

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

Body ()

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

Back to Top