Retrieve Insights
post
https://server:port/spl/rest/apis/common/system/insights/
This service retrieves one or more insights for a given context and a specific insight class or type. Insight information includes details about each insight along with recommended visual settings.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
contextEntry: array
contextEntry
Identifies the context for which insights are requested. The context may include one or more referenced entities such as a person, an account, a bill etc. Business rules associated with the requested insight types use the provided context to prepare corresponding insights.
-
insightClass: string
Allowed Values:
[ "C1CC", "C1CI", "C1CL", "C1CU", "C1FH", "C1PA", "C1PE", "C1SA", "C1SP", "C1SS", "C1UB" ]
Represents a group of insight types that can be presented in the same UI location. Either an insight class or a type should be provided. * `C1CC` - Credit and Collections, * `C1CI` - Customer Insights, * `C1CL` - Customer Context (Lower), * `C1CU` - Customer Context (Upper), * `C1FH` - Financial History, * `C1PA` - Payment Agreements, * `C1PE` - Program Enrollment, * `C1SA` - Start/Stop/Transfer Insights - Account-Based, * `C1SP` - Start/Stop/Transfer Insights - Premise-Based, * `C1SS` - Start/Stop/Transfer Insights - Service-Based, * `C1UB` - Usage and Billing -
insightType: string
Maximum Length:
30
A specific type of insight to process. Either an insight class or a type should be provided.
Nested Schema : contextEntry
Type:
array
Identifies the context for which insights are requested. The context may include one or more referenced entities such as a person, an account, a bill etc. Business rules associated with the requested insight types use the provided context to prepare corresponding insights.
Show Source
Nested Schema : items
Type:
Show Source
object
-
contextName: string
Maximum Length:
12
Context Name -
contextValue: string
Maximum Length:
12
Context Value
Root Schema : schema
Type:
Show Source
object
-
contextEntry: array
contextEntry
Identifies the context for which insights are requested. The context may include one or more referenced entities such as a person, an account, a bill etc. Business rules associated with the requested insight types use the provided context to prepare corresponding insights.
-
insightClass: string
Allowed Values:
[ "C1CC", "C1CI", "C1CL", "C1CU", "C1FH", "C1PA", "C1PE", "C1SA", "C1SP", "C1SS", "C1UB" ]
Represents a group of insight types that can be presented in the same UI location. Either an insight class or a type should be provided. * `C1CC` - Credit and Collections, * `C1CI` - Customer Insights, * `C1CL` - Customer Context (Lower), * `C1CU` - Customer Context (Upper), * `C1FH` - Financial History, * `C1PA` - Payment Agreements, * `C1PE` - Program Enrollment, * `C1SA` - Start/Stop/Transfer Insights - Account-Based, * `C1SP` - Start/Stop/Transfer Insights - Premise-Based, * `C1SS` - Start/Stop/Transfer Insights - Service-Based, * `C1UB` - Usage and Billing -
insightType: string
Maximum Length:
30
A specific type of insight to process. Either an insight class or a type should be provided.
Nested Schema : contextEntry
Type:
array
Identifies the context for which insights are requested. The context may include one or more referenced entities such as a person, an account, a bill etc. Business rules associated with the requested insight types use the provided context to prepare corresponding insights.
Show Source
Nested Schema : items
Type:
Show Source
object
-
contextName: string
Maximum Length:
12
Context Name -
contextValue: string
Maximum Length:
12
Context Value
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object
-
insightDetails: object
insightDetails
-
insightType: string
Maximum Length:
30
The type of the insight. -
insightVisualDetails: object
insightVisualDetails
Recommended visualization settings that may be used when rendering each insight.
-
sequence: number
Minimum Value:
-999
Maximum Value:999
The order in which insights should be presented.
Nested Schema : insightDetails
Type:
Show Source
object
-
primaryMessageText: string
Maximum Length:
4000
Describes the main message text for the insight. -
secondaryMessageText: string
Maximum Length:
4000
Provides additional information about the insight. -
severityValue: string
Maximum Length:
6
Ranks the severity of the insight relative to insights of this type. May be by external configurations to control various visualization aspects of the insight.
Nested Schema : insightVisualDetails
Type:
object
Recommended visualization settings that may be used when rendering each insight.
Show Source
-
displayIcon: string
Maximum Length:
12
Display Icon -
headerBackgroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
headerCategory: string
Allowed Values:
[ "F1ER", "F1IN", "F1WN" ]
Header Category: * `F1ER` - Error, * `F1IN` - Information, * `F1WN` - Warning -
headerForegroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
iconBackgroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
iconForegroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
insightBackgroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
insightForegroundHexColorCode: string
Maximum Length:
60
Hex Color Code -
visualStructure: string
Allowed Values:
[ "F1BD", "F1CI", "F1II", "F1LI" ]
Visual Structure: * `F1BD` - Badge Insight, * `F1CI` - Card Insight, * `F1II` - Inline Insight, * `F1LI` - List Insight
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.