Oracle Utilities REST API for Metering and Customer Information

Get Installed Patches

get

/rest/apis/common/system/InstalledPatches/

This operation retrieves the list of patches installed in the environment for the current version of all the products in the stack. The list includes the products installed (owner flag), their versions and lists each installed fix. Each fix entry includes the bug number, the patch number, the owner flag of the product that owns the issue, the product version and the date / time the fix was installed. You can provide an owner flag to limit the results to patches related to that owner's product.

Request

Query Parameters

ownerFlag: string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : F1-GetInstalledPatches

Type: object

Show Source

installedFixes: array installedFixes

This list includes an entry for each installed fix that is found.
installedProducts: array installedProducts

This list displays each product (owner flag) installed in this environment and the version of the product.

{
    "type":"object",
    "properties":{
        "installedProducts":{
            "type":"array",
            "description":"This list displays each product (owner flag) installed in this environment and the version of the product.",
            "items":{
                "type":"object",
                "properties":{
                    "ownerFlag":{
                        "type":"string",
                        "enum":[
                            "C1  ",
                            "CM  ",
                            "F1  ",
                            "UM  "
                        ],
                        "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
                    },
                    "productVersion":{
                        "type":"string",
                        "maxLength":40,
                        "description":"Release Version"
                    }
                }
            }
        },
        "installedFixes":{
            "type":"array",
            "description":"This list includes an entry for each installed fix that is found.",
            "items":{
                "type":"object",
                "properties":{
                    "bugNumber":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Bug Number"
                    },
                    "ownerFlag":{
                        "type":"string",
                        "enum":[
                            "C1  ",
                            "CM  ",
                            "F1  ",
                            "UM  "
                        ],
                        "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
                    },
                    "productVersion":{
                        "type":"string",
                        "maxLength":40,
                        "description":"Release Version"
                    },
                    "nlsKit":{
                        "type":"string",
                        "maxLength":8,
                        "description":"This field includes the patch number (single fix number) associated with this fix.",
                        "example":"SF.034"
                    },
                    "installationDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"This is the date and time that the patch was installed in this environment."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"F1-GetInstalledPatches"
    }
}

Nested Schema : installedFixes

Type: array

This list includes an entry for each installed fix that is found.

Show Source

Array of: object items

{
    "type":"array",
    "description":"This list includes an entry for each installed fix that is found.",
    "items":{
        "type":"object",
        "properties":{
            "bugNumber":{
                "type":"string",
                "maxLength":10,
                "description":"Bug Number"
            },
            "ownerFlag":{
                "type":"string",
                "enum":[
                    "C1  ",
                    "CM  ",
                    "F1  ",
                    "UM  "
                ],
                "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
            },
            "productVersion":{
                "type":"string",
                "maxLength":40,
                "description":"Release Version"
            },
            "nlsKit":{
                "type":"string",
                "maxLength":8,
                "description":"This field includes the patch number (single fix number) associated with this fix.",
                "example":"SF.034"
            },
            "installationDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"This is the date and time that the patch was installed in this environment."
            }
        }
    }
}

Nested Schema : installedProducts

Type: array

This list displays each product (owner flag) installed in this environment and the version of the product.

Show Source

Array of: object items

{
    "type":"array",
    "description":"This list displays each product (owner flag) installed in this environment and the version of the product.",
    "items":{
        "type":"object",
        "properties":{
            "ownerFlag":{
                "type":"string",
                "enum":[
                    "C1  ",
                    "CM  ",
                    "F1  ",
                    "UM  "
                ],
                "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
            },
            "productVersion":{
                "type":"string",
                "maxLength":40,
                "description":"Release Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

bugNumber: string

Maximum Length: 10

Bug Number
installationDateTime: string (date-time)

This is the date and time that the patch was installed in this environment.
nlsKit: string

Maximum Length: 8

This field includes the patch number (single fix number) associated with this fix.

Example: SF.034
ownerFlag: string

Allowed Values: [ "C1 ", "CM ", "F1 ", "UM " ]

Owner: * `C1 ` - Customer Care and Billing, * `CM ` - Customer Modification, * `F1 ` - Framework, * `UM ` - Utility Markets
productVersion: string

Maximum Length: 40

Release Version

{
    "type":"object",
    "properties":{
        "bugNumber":{
            "type":"string",
            "maxLength":10,
            "description":"Bug Number"
        },
        "ownerFlag":{
            "type":"string",
            "enum":[
                "C1  ",
                "CM  ",
                "F1  ",
                "UM  "
            ],
            "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
        },
        "productVersion":{
            "type":"string",
            "maxLength":40,
            "description":"Release Version"
        },
        "nlsKit":{
            "type":"string",
            "maxLength":8,
            "description":"This field includes the patch number (single fix number) associated with this fix.",
            "example":"SF.034"
        },
        "installationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"This is the date and time that the patch was installed in this environment."
        }
    }
}

Nested Schema : items

Type: object

Show Source

ownerFlag: string

Allowed Values: [ "C1 ", "CM ", "F1 ", "UM " ]

Owner: * `C1 ` - Customer Care and Billing, * `CM ` - Customer Modification, * `F1 ` - Framework, * `UM ` - Utility Markets
productVersion: string

Maximum Length: 40

Release Version

{
    "type":"object",
    "properties":{
        "ownerFlag":{
            "type":"string",
            "enum":[
                "C1  ",
                "CM  ",
                "F1  ",
                "UM  "
            ],
            "description":"Owner:\n* `C1  ` - Customer Care and Billing,\n* `CM  ` - Customer Modification,\n* `F1  ` - Framework,\n* `UM  ` - Utility Markets"
        },
        "productVersion":{
            "type":"string",
            "maxLength":40,
            "description":"Release Version"
        }
    }
}

400 Response

Bad Request

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

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