Get Health Check
get
/rest/apis/common/system/healthCheck/
This operation calls the health check service.
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : F1-HealthCheck
Type:
Show Source
object-
healthCheckResults: array
healthCheckResults
-
healthOverallResponse: number
Minimum Value:
0Maximum Value:999Overall Response
Nested Schema : items
Type:
Show Source
object-
healthCompDetail: string
Maximum Length:
200Health Component Details -
healthCompFlg: string
Allowed Values:
[ "BLOS" ]Health Component: * `BLOS` - Batch -
healthCompResponse: number
Minimum Value:
0Maximum Value:999Response -
healthCompStatusDescr: string
Maximum Length:
60Status -
healthCompStatusFlg: string
Maximum Length:
4Status Flag -
healthCompStatusReason: string
Maximum Length:
4100Status Reason -
mo: string
Maximum Length:
12Maintenance Object - navOpt: string
-
pkFld1: string
Maximum Length:
30Field -
pkFld2: string
Maximum Length:
30Field -
pkFld3: string
Maximum Length:
30Field -
pkFld4: string
Maximum Length:
30Field -
pkFld5: string
Maximum Length:
30Field -
pkVal1: string
Maximum Length:
254Primary Key 1 -
pkVal2: string
Maximum Length:
254Primary Key 2 -
pkVal3: string
Maximum Length:
254Primary Key 3 -
pkVal4: string
Maximum Length:
254Primary Key 4 -
pkVal5: string
Maximum Length:
254Primary Key 5 -
responseDetails: array
responseDetails
Nested Schema : items
Type:
Show Source
object-
healthCompResponse: number
Minimum Value:
0Maximum Value:999Response -
healthCompStatusDescr: string
Maximum Length:
60Status -
healthCompStatusFlg: string
Maximum Length:
4Status Flag -
healthCompStatusReason: string
Maximum Length:
4100Status Reason
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.