Jump to

• Request
• Response

Sync Business Flag

post

/rest/apis/common/insights/businessInsights/

This operation is used to create or update a business flag record based on input information.

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

• F1-BusFlgSyn: object F1-BusFlgSyn

{
    "type":"object",
    "properties":{
        "F1-BusFlgSyn":{
            "type":"object",
            "properties":{
                "businessFlagId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Business Flag"
                },
                "externalBusinessFlagId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Business Flag ID"
                },
                "standardName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Value"
                },
                "sourceFileId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Source File ID"
                },
                "externalSystemReference":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System Reference"
                },
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Affected Entity ID"
                },
                "mo":{
                    "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"
                },
                "businessFlagDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag Date/Time"
                },
                "businessFlagEndDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag End Date/Time"
                },
                "confidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "finalConfidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "priority":{
                    "type":"string",
                    "enum":[
                        "010 ",
                        "020 ",
                        "030 ",
                        "040 ",
                        "050 ",
                        "060 ",
                        "070 ",
                        "080 ",
                        "090 "
                    ],
                    "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
                },
                "contextData":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : F1-BusFlgSyn

Type: object

Show Source

• businessFlagDateTime: string (date-time)
  Business Flag Date/Time
• businessFlagEndDateTime: string (date-time)
  Business Flag End Date/Time
• businessFlagId: string
  Maximum Length: 14

  Business Flag
• confidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• contextData: object contextData
• externalBusinessFlagId: string
  Maximum Length: 254

  External Business Flag ID
• externalId: string
  Maximum Length: 254

  External Affected Entity ID
• externalSystem: string
  Maximum Length: 30

  External System
• externalSystemReference: string
  Maximum Length: 30

  External System Reference
• finalConfidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Final Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• mo: 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
• priority: string
  Allowed Values: [ "010 ", "020 ", "030 ", "040 ", "050 ", "060 ", "070 ", "080 ", "090 " ]

  Priority: * `010 ` - Priority 10 -- Highest, * `020 ` - Priority 20, * `030 ` - Priority 30, * `040 ` - Priority 40, * `050 ` - Priority 50, * `060 ` - Priority 60, * `070 ` - Priority 70, * `080 ` - Priority 80, * `090 ` - Priority 90 -- Lowest
• sourceFileId: string
  Maximum Length: 254

  Source File ID
• standardName: string
  Maximum Length: 254

  Value

{
    "type":"object",
    "properties":{
        "businessFlagId":{
            "type":"string",
            "maxLength":14,
            "description":"Business Flag"
        },
        "externalBusinessFlagId":{
            "type":"string",
            "maxLength":254,
            "description":"External Business Flag ID"
        },
        "standardName":{
            "type":"string",
            "maxLength":254,
            "description":"Value"
        },
        "sourceFileId":{
            "type":"string",
            "maxLength":254,
            "description":"Source File ID"
        },
        "externalSystemReference":{
            "type":"string",
            "maxLength":30,
            "description":"External System Reference"
        },
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "externalId":{
            "type":"string",
            "maxLength":254,
            "description":"External Affected Entity ID"
        },
        "mo":{
            "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"
        },
        "businessFlagDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag Date/Time"
        },
        "businessFlagEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag End Date/Time"
        },
        "confidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "finalConfidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "priority":{
            "type":"string",
            "enum":[
                "010 ",
                "020 ",
                "030 ",
                "040 ",
                "050 ",
                "060 ",
                "070 ",
                "080 ",
                "090 "
            ],
            "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
        },
        "contextData":{
            "type":"object"
        }
    }
}

Nested Schema : contextData

Type: object

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• F1-BusFlgSyn: object F1-BusFlgSyn

{
    "type":"object",
    "properties":{
        "F1-BusFlgSyn":{
            "type":"object",
            "properties":{
                "businessFlagId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Business Flag"
                },
                "externalBusinessFlagId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Business Flag ID"
                },
                "standardName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Value"
                },
                "sourceFileId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Source File ID"
                },
                "externalSystemReference":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System Reference"
                },
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Affected Entity ID"
                },
                "mo":{
                    "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"
                },
                "businessFlagDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag Date/Time"
                },
                "businessFlagEndDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag End Date/Time"
                },
                "confidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "finalConfidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "priority":{
                    "type":"string",
                    "enum":[
                        "010 ",
                        "020 ",
                        "030 ",
                        "040 ",
                        "050 ",
                        "060 ",
                        "070 ",
                        "080 ",
                        "090 "
                    ],
                    "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
                },
                "contextData":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : F1-BusFlgSyn

Type: object

Show Source

• businessFlagDateTime: string (date-time)
  Business Flag Date/Time
• businessFlagEndDateTime: string (date-time)
  Business Flag End Date/Time
• businessFlagId: string
  Maximum Length: 14

  Business Flag
• confidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• contextData: object contextData
• externalBusinessFlagId: string
  Maximum Length: 254

  External Business Flag ID
• externalId: string
  Maximum Length: 254

  External Affected Entity ID
• externalSystem: string
  Maximum Length: 30

  External System
• externalSystemReference: string
  Maximum Length: 30

  External System Reference
• finalConfidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Final Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• mo: 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
• priority: string
  Allowed Values: [ "010 ", "020 ", "030 ", "040 ", "050 ", "060 ", "070 ", "080 ", "090 " ]

  Priority: * `010 ` - Priority 10 -- Highest, * `020 ` - Priority 20, * `030 ` - Priority 30, * `040 ` - Priority 40, * `050 ` - Priority 50, * `060 ` - Priority 60, * `070 ` - Priority 70, * `080 ` - Priority 80, * `090 ` - Priority 90 -- Lowest
• sourceFileId: string
  Maximum Length: 254

  Source File ID
• standardName: string
  Maximum Length: 254

  Value

{
    "type":"object",
    "properties":{
        "businessFlagId":{
            "type":"string",
            "maxLength":14,
            "description":"Business Flag"
        },
        "externalBusinessFlagId":{
            "type":"string",
            "maxLength":254,
            "description":"External Business Flag ID"
        },
        "standardName":{
            "type":"string",
            "maxLength":254,
            "description":"Value"
        },
        "sourceFileId":{
            "type":"string",
            "maxLength":254,
            "description":"Source File ID"
        },
        "externalSystemReference":{
            "type":"string",
            "maxLength":30,
            "description":"External System Reference"
        },
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "externalId":{
            "type":"string",
            "maxLength":254,
            "description":"External Affected Entity ID"
        },
        "mo":{
            "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"
        },
        "businessFlagDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag Date/Time"
        },
        "businessFlagEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag End Date/Time"
        },
        "confidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "finalConfidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "priority":{
            "type":"string",
            "enum":[
                "010 ",
                "020 ",
                "030 ",
                "040 ",
                "050 ",
                "060 ",
                "070 ",
                "080 ",
                "090 "
            ],
            "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
        },
        "contextData":{
            "type":"object"
        }
    }
}

Nested Schema : contextData

Type: object

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : CREATE_response

Type: object

Show Source

• F1-BusFlgSyn: object F1-BusFlgSyn

{
    "type":"object",
    "properties":{
        "F1-BusFlgSyn":{
            "type":"object",
            "properties":{
                "businessFlagId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Business Flag"
                },
                "externalBusinessFlagId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Business Flag ID"
                },
                "standardName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Value"
                },
                "sourceFileId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Source File ID"
                },
                "externalSystemReference":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System Reference"
                },
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System"
                },
                "externalId":{
                    "type":"string",
                    "maxLength":254,
                    "description":"External Affected Entity ID"
                },
                "mo":{
                    "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"
                },
                "businessFlagDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag Date/Time"
                },
                "businessFlagEndDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Business Flag End Date/Time"
                },
                "confidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "finalConfidence":{
                    "type":"string",
                    "enum":[
                        "CONF",
                        "MISS",
                        "REJ ",
                        "SUSP"
                    ],
                    "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
                },
                "priority":{
                    "type":"string",
                    "enum":[
                        "010 ",
                        "020 ",
                        "030 ",
                        "040 ",
                        "050 ",
                        "060 ",
                        "070 ",
                        "080 ",
                        "090 "
                    ],
                    "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
                },
                "contextData":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : F1-BusFlgSyn

Type: object

Show Source

• businessFlagDateTime: string (date-time)
  Business Flag Date/Time
• businessFlagEndDateTime: string (date-time)
  Business Flag End Date/Time
• businessFlagId: string
  Maximum Length: 14

  Business Flag
• confidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• contextData: object contextData
• externalBusinessFlagId: string
  Maximum Length: 254

  External Business Flag ID
• externalId: string
  Maximum Length: 254

  External Affected Entity ID
• externalSystem: string
  Maximum Length: 30

  External System
• externalSystemReference: string
  Maximum Length: 30

  External System Reference
• finalConfidence: string
  Allowed Values: [ "CONF", "MISS", "REJ ", "SUSP" ]

  Final Confidence: * `CONF` - Confirmed, * `MISS` - Missed, * `REJ ` - Rejected, * `SUSP` - Suspected
• mo: 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
• priority: string
  Allowed Values: [ "010 ", "020 ", "030 ", "040 ", "050 ", "060 ", "070 ", "080 ", "090 " ]

  Priority: * `010 ` - Priority 10 -- Highest, * `020 ` - Priority 20, * `030 ` - Priority 30, * `040 ` - Priority 40, * `050 ` - Priority 50, * `060 ` - Priority 60, * `070 ` - Priority 70, * `080 ` - Priority 80, * `090 ` - Priority 90 -- Lowest
• sourceFileId: string
  Maximum Length: 254

  Source File ID
• standardName: string
  Maximum Length: 254

  Value

{
    "type":"object",
    "properties":{
        "businessFlagId":{
            "type":"string",
            "maxLength":14,
            "description":"Business Flag"
        },
        "externalBusinessFlagId":{
            "type":"string",
            "maxLength":254,
            "description":"External Business Flag ID"
        },
        "standardName":{
            "type":"string",
            "maxLength":254,
            "description":"Value"
        },
        "sourceFileId":{
            "type":"string",
            "maxLength":254,
            "description":"Source File ID"
        },
        "externalSystemReference":{
            "type":"string",
            "maxLength":30,
            "description":"External System Reference"
        },
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "externalId":{
            "type":"string",
            "maxLength":254,
            "description":"External Affected Entity ID"
        },
        "mo":{
            "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"
        },
        "businessFlagDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag Date/Time"
        },
        "businessFlagEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Business Flag End Date/Time"
        },
        "confidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "finalConfidence":{
            "type":"string",
            "enum":[
                "CONF",
                "MISS",
                "REJ ",
                "SUSP"
            ],
            "description":"Final Confidence:\n* `CONF` - Confirmed,\n* `MISS` - Missed,\n* `REJ ` - Rejected,\n* `SUSP` - Suspected"
        },
        "priority":{
            "type":"string",
            "enum":[
                "010 ",
                "020 ",
                "030 ",
                "040 ",
                "050 ",
                "060 ",
                "070 ",
                "080 ",
                "090 "
            ],
            "description":"Priority:\n* `010 ` - Priority 10 -- Highest,\n* `020 ` - Priority 20,\n* `030 ` - Priority 30,\n* `040 ` - Priority 40,\n* `050 ` - Priority 50,\n* `060 ` - Priority 60,\n* `070 ` - Priority 70,\n* `080 ` - Priority 80,\n* `090 ` - Priority 90 -- Lowest"
        },
        "contextData":{
            "type":"object"
        }
    }
}

Nested Schema : contextData

Type: object

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