Jump to

• Request
• Response

Retrieve Insights

post

/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

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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", "C1XA", "C1XC", "C1XP" ]

  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, * `C1XA` - CX Billing Account Insights-KAM, * `C1XC` - CX Billing Account Insights-Agent, * `C1XP` - CX Business Insights
• insightType: string
  Maximum Length: 30

  A specific type of insight to process. Either an insight class or a type should be provided.

{
    "type":"object",
    "properties":{
        "insightClass":{
            "type":"string",
            "enum":[
                "C1CC",
                "C1CI",
                "C1CL",
                "C1CU",
                "C1FH",
                "C1PA",
                "C1PE",
                "C1SA",
                "C1SP",
                "C1SS",
                "C1UB",
                "C1XA",
                "C1XC",
                "C1XP"
            ],
            "description":"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.\n* `C1CC` - Credit and Collections,\n* `C1CI` - Customer Insights,\n* `C1CL` - Customer Context (Lower),\n* `C1CU` - Customer Context (Upper),\n* `C1FH` - Financial History,\n* `C1PA` - Payment Agreements,\n* `C1PE` - Program Enrollment,\n* `C1SA` - Start/Stop/Transfer Insights - Account-Based,\n* `C1SP` - Start/Stop/Transfer Insights - Premise-Based,\n* `C1SS` - Start/Stop/Transfer Insights - Service-Based,\n* `C1UB` - Usage and Billing,\n* `C1XA` - CX Billing Account Insights-KAM,\n* `C1XC` - CX Billing Account Insights-Agent,\n* `C1XP` - CX Business Insights"
        },
        "insightType":{
            "type":"string",
            "maxLength":30,
            "description":"A specific type of insight to process. Either an insight class or a type should be provided."
        },
        "contextEntry":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"object",
                "properties":{
                    "contextName":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Context Name"
                    },
                    "contextValue":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Context Value"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Insights"
    }
}

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

• Array of: object items

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"object",
        "properties":{
            "contextName":{
                "type":"string",
                "maxLength":12,
                "description":"Context Name"
            },
            "contextValue":{
                "type":"string",
                "maxLength":12,
                "description":"Context Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• contextName: string
  Maximum Length: 12

  Context Name
• contextValue: string
  Maximum Length: 12

  Context Value

{
    "type":"object",
    "properties":{
        "contextName":{
            "type":"string",
            "maxLength":12,
            "description":"Context Name"
        },
        "contextValue":{
            "type":"string",
            "maxLength":12,
            "description":"Context Value"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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", "C1XA", "C1XC", "C1XP" ]

  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, * `C1XA` - CX Billing Account Insights-KAM, * `C1XC` - CX Billing Account Insights-Agent, * `C1XP` - CX Business Insights
• insightType: string
  Maximum Length: 30

  A specific type of insight to process. Either an insight class or a type should be provided.

{
    "type":"object",
    "properties":{
        "insightClass":{
            "type":"string",
            "enum":[
                "C1CC",
                "C1CI",
                "C1CL",
                "C1CU",
                "C1FH",
                "C1PA",
                "C1PE",
                "C1SA",
                "C1SP",
                "C1SS",
                "C1UB",
                "C1XA",
                "C1XC",
                "C1XP"
            ],
            "description":"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.\n* `C1CC` - Credit and Collections,\n* `C1CI` - Customer Insights,\n* `C1CL` - Customer Context (Lower),\n* `C1CU` - Customer Context (Upper),\n* `C1FH` - Financial History,\n* `C1PA` - Payment Agreements,\n* `C1PE` - Program Enrollment,\n* `C1SA` - Start/Stop/Transfer Insights - Account-Based,\n* `C1SP` - Start/Stop/Transfer Insights - Premise-Based,\n* `C1SS` - Start/Stop/Transfer Insights - Service-Based,\n* `C1UB` - Usage and Billing,\n* `C1XA` - CX Billing Account Insights-KAM,\n* `C1XC` - CX Billing Account Insights-Agent,\n* `C1XP` - CX Business Insights"
        },
        "insightType":{
            "type":"string",
            "maxLength":30,
            "description":"A specific type of insight to process. Either an insight class or a type should be provided."
        },
        "contextEntry":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"object",
                "properties":{
                    "contextName":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Context Name"
                    },
                    "contextValue":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Context Value"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Insights"
    }
}

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

• Array of: object items

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"object",
        "properties":{
            "contextName":{
                "type":"string",
                "maxLength":12,
                "description":"Context Name"
            },
            "contextValue":{
                "type":"string",
                "maxLength":12,
                "description":"Context Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• contextName: string
  Maximum Length: 12

  Context Name
• contextValue: string
  Maximum Length: 12

  Context Value

{
    "type":"object",
    "properties":{
        "contextName":{
            "type":"string",
            "maxLength":12,
            "description":"Context Name"
        },
        "contextValue":{
            "type":"string",
            "maxLength":12,
            "description":"Context Value"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : F1Insights

Type: object

Show Source

• insights: array insights

{
    "type":"object",
    "properties":{
        "insights":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"The order in which insights should be presented."
                    },
                    "insightType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"The type of the insight."
                    },
                    "insightDetails":{
                        "type":"object",
                        "properties":{
                            "primaryMessageText":{
                                "type":"string",
                                "maxLength":4000,
                                "description":"Describes the main message text for the insight."
                            },
                            "secondaryMessageText":{
                                "type":"string",
                                "maxLength":4000,
                                "description":"Provides additional information about the insight."
                            },
                            "severityValue":{
                                "type":"number",
                                "maximum":999999,
                                "minimum":0,
                                "description":"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."
                            }
                        }
                    },
                    "insightEntity":{
                        "type":"object",
                        "description":"When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.",
                        "properties":{
                            "entityName":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Maintenance Object"
                            },
                            "pkValue1":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Primary Key 1"
                            },
                            "pkValue2":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Primary Key 2"
                            },
                            "pkValue3":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Primary Key 3"
                            },
                            "pkValue4":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Primary Key 4"
                            },
                            "pkValue5":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Primary Key 5"
                            }
                        }
                    },
                    "insightVisualDetails":{
                        "type":"object",
                        "description":"Recommended visualization settings that may be used when rendering each insight.",
                        "properties":{
                            "visualStructure":{
                                "type":"string",
                                "enum":[
                                    "F1BD",
                                    "F1CI",
                                    "F1II",
                                    "F1LI"
                                ],
                                "description":"Visual Structure:\n* `F1BD` - Badge Insight,\n* `F1CI` - Card Insight,\n* `F1II` - Inline Insight,\n* `F1LI` - List Insight"
                            },
                            "displayIcon":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Display Icon"
                            },
                            "iconForegroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            },
                            "iconBackgroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            },
                            "headerCategory":{
                                "type":"string",
                                "enum":[
                                    "F1ER",
                                    "F1IN",
                                    "F1WN"
                                ],
                                "description":"Header Category:\n* `F1ER` - Error,\n* `F1IN` - Information,\n* `F1WN` - Warning"
                            },
                            "headerCategoryDescr":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "headerForegroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            },
                            "headerBackgroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            },
                            "insightForegroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            },
                            "insightBackgroundHexColorCode":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Hex Color Code"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1Insights"
    }
}

Nested Schema : insights

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"The order in which insights should be presented."
            },
            "insightType":{
                "type":"string",
                "maxLength":30,
                "description":"The type of the insight."
            },
            "insightDetails":{
                "type":"object",
                "properties":{
                    "primaryMessageText":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Describes the main message text for the insight."
                    },
                    "secondaryMessageText":{
                        "type":"string",
                        "maxLength":4000,
                        "description":"Provides additional information about the insight."
                    },
                    "severityValue":{
                        "type":"number",
                        "maximum":999999,
                        "minimum":0,
                        "description":"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."
                    }
                }
            },
            "insightEntity":{
                "type":"object",
                "description":"When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.",
                "properties":{
                    "entityName":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Maintenance Object"
                    },
                    "pkValue1":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Primary Key 1"
                    },
                    "pkValue2":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Primary Key 2"
                    },
                    "pkValue3":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Primary Key 3"
                    },
                    "pkValue4":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Primary Key 4"
                    },
                    "pkValue5":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Primary Key 5"
                    }
                }
            },
            "insightVisualDetails":{
                "type":"object",
                "description":"Recommended visualization settings that may be used when rendering each insight.",
                "properties":{
                    "visualStructure":{
                        "type":"string",
                        "enum":[
                            "F1BD",
                            "F1CI",
                            "F1II",
                            "F1LI"
                        ],
                        "description":"Visual Structure:\n* `F1BD` - Badge Insight,\n* `F1CI` - Card Insight,\n* `F1II` - Inline Insight,\n* `F1LI` - List Insight"
                    },
                    "displayIcon":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Display Icon"
                    },
                    "iconForegroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    },
                    "iconBackgroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    },
                    "headerCategory":{
                        "type":"string",
                        "enum":[
                            "F1ER",
                            "F1IN",
                            "F1WN"
                        ],
                        "description":"Header Category:\n* `F1ER` - Error,\n* `F1IN` - Information,\n* `F1WN` - Warning"
                    },
                    "headerCategoryDescr":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "headerForegroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    },
                    "headerBackgroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    },
                    "insightForegroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    },
                    "insightBackgroundHexColorCode":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Hex Color Code"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• insightDetails: object insightDetails
• insightEntity: object insightEntity
  When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.
• 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.

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"The order in which insights should be presented."
        },
        "insightType":{
            "type":"string",
            "maxLength":30,
            "description":"The type of the insight."
        },
        "insightDetails":{
            "type":"object",
            "properties":{
                "primaryMessageText":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Describes the main message text for the insight."
                },
                "secondaryMessageText":{
                    "type":"string",
                    "maxLength":4000,
                    "description":"Provides additional information about the insight."
                },
                "severityValue":{
                    "type":"number",
                    "maximum":999999,
                    "minimum":0,
                    "description":"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."
                }
            }
        },
        "insightEntity":{
            "type":"object",
            "description":"When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.",
            "properties":{
                "entityName":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Maintenance Object"
                },
                "pkValue1":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Primary Key 1"
                },
                "pkValue2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Primary Key 2"
                },
                "pkValue3":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Primary Key 3"
                },
                "pkValue4":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Primary Key 4"
                },
                "pkValue5":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Primary Key 5"
                }
            }
        },
        "insightVisualDetails":{
            "type":"object",
            "description":"Recommended visualization settings that may be used when rendering each insight.",
            "properties":{
                "visualStructure":{
                    "type":"string",
                    "enum":[
                        "F1BD",
                        "F1CI",
                        "F1II",
                        "F1LI"
                    ],
                    "description":"Visual Structure:\n* `F1BD` - Badge Insight,\n* `F1CI` - Card Insight,\n* `F1II` - Inline Insight,\n* `F1LI` - List Insight"
                },
                "displayIcon":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Display Icon"
                },
                "iconForegroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                },
                "iconBackgroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                },
                "headerCategory":{
                    "type":"string",
                    "enum":[
                        "F1ER",
                        "F1IN",
                        "F1WN"
                    ],
                    "description":"Header Category:\n* `F1ER` - Error,\n* `F1IN` - Information,\n* `F1WN` - Warning"
                },
                "headerCategoryDescr":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                },
                "headerForegroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                },
                "headerBackgroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                },
                "insightForegroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                },
                "insightBackgroundHexColorCode":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Hex Color Code"
                }
            }
        }
    }
}

Nested Schema : insightDetails

Type: object

Show Source

• 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: number
  Minimum Value: 0

  Maximum Value: 999999

  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.

{
    "type":"object",
    "properties":{
        "primaryMessageText":{
            "type":"string",
            "maxLength":4000,
            "description":"Describes the main message text for the insight."
        },
        "secondaryMessageText":{
            "type":"string",
            "maxLength":4000,
            "description":"Provides additional information about the insight."
        },
        "severityValue":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"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 : insightEntity

Type: object

When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.

Show Source

• entityName: string
  Maximum Length: 12

  Maintenance Object
• pkValue1: string
  Maximum Length: 254

  Primary Key 1
• pkValue2: string
  Maximum Length: 254

  Primary Key 2
• pkValue3: string
  Maximum Length: 254

  Primary Key 3
• pkValue4: string
  Maximum Length: 254

  Primary Key 4
• pkValue5: string
  Maximum Length: 254

  Primary Key 5

{
    "type":"object",
    "description":"When an insight is associated with a business entity, the entity's name and primary key details are provided to support further flows that may interact with the entity.",
    "properties":{
        "entityName":{
            "type":"string",
            "maxLength":12,
            "description":"Maintenance Object"
        },
        "pkValue1":{
            "type":"string",
            "maxLength":254,
            "description":"Primary Key 1"
        },
        "pkValue2":{
            "type":"string",
            "maxLength":254,
            "description":"Primary Key 2"
        },
        "pkValue3":{
            "type":"string",
            "maxLength":254,
            "description":"Primary Key 3"
        },
        "pkValue4":{
            "type":"string",
            "maxLength":254,
            "description":"Primary Key 4"
        },
        "pkValue5":{
            "type":"string",
            "maxLength":254,
            "description":"Primary Key 5"
        }
    }
}

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
• headerCategoryDescr: string
  Maximum Length: 60

  Description
• 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

{
    "type":"object",
    "description":"Recommended visualization settings that may be used when rendering each insight.",
    "properties":{
        "visualStructure":{
            "type":"string",
            "enum":[
                "F1BD",
                "F1CI",
                "F1II",
                "F1LI"
            ],
            "description":"Visual Structure:\n* `F1BD` - Badge Insight,\n* `F1CI` - Card Insight,\n* `F1II` - Inline Insight,\n* `F1LI` - List Insight"
        },
        "displayIcon":{
            "type":"string",
            "maxLength":12,
            "description":"Display Icon"
        },
        "iconForegroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        },
        "iconBackgroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        },
        "headerCategory":{
            "type":"string",
            "enum":[
                "F1ER",
                "F1IN",
                "F1WN"
            ],
            "description":"Header Category:\n* `F1ER` - Error,\n* `F1IN` - Information,\n* `F1WN` - Warning"
        },
        "headerCategoryDescr":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "headerForegroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        },
        "headerBackgroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        },
        "insightForegroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        },
        "insightBackgroundHexColorCode":{
            "type":"string",
            "maxLength":60,
            "description":"Hex Color Code"
        }
    }
}

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