Jump to

• Request
• Response

Recommend Patches for Image Version

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/versions/{versionId}/patchRecommendations

Compares the patches included in the specified version of the image against Oracle recommendations and provides a list of patches to be included into the next version.

Request

Path Parameters

• goldImageId(required): string
  ID of the Image
• versionId(required): string
  ID of the Image Version

Query Parameters

• include: string
  Provide list of bugs fixed (if available)

  Allowed Values: [ "bugs" ]

  Example:

  bugs

• patchId: string
  Id of the patch

  Example:

  34086870

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Image version patch recommendations is retrieved.

Body ()

Root Schema : VersionPatchRecommendationCollection

Type: object

Response of Patch recommendation for Database Gold Image Version

Show Source

• messages: object messages
  Message additional information about how to get and to use the recommended patches
• oracleRecommendedPatches: object oracleRecommendedPatches
  Oracle recommended patch details

{
    "description":"Response of Patch recommendation for Database Gold Image Version",
    "type":"object",
    "properties":{
        "messages":{
            "description":"Message additional information about how to get and to use the recommended patches",
            "type":"object",
            "properties":{
                "uploadPatches":{
                    "description":"Gives the information about how to get/upload the recommended patches in EM",
                    "type":"string",
                    "example":"To upload recommended patches in EM use the following command: emcli upload_patches -from_host=host_name -patch_files=metadata_file_path;ZIP_file_path [-cred_name=name -cred_owner=owner]. In online connection mode, the patches can be directly downloaded to EM as well."
                },
                "createNewVersion":{
                    "description":"Gives the information about how to create the new version of image from the recommended patches",
                    "type":"string",
                    "example":"To create a new version of the image with the recommended patches see: https://www.oracle.com/pls/topic/lookup?ctx=en/enterprise-manager&id=EMLCM-GUID-431C8AE4-774B-4DD8-89A5-A6A30B071740."
                }
            }
        },
        "oracleRecommendedPatches":{
            "description":"Oracle recommended patch details",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/PatchRecommendationDetail"
                }
            ]
        }
    }
}

Nested Schema : messages

Type: object

Message additional information about how to get and to use the recommended patches

Show Source

• createNewVersion: string
  Gives the information about how to create the new version of image from the recommended patches

  Example: To create a new version of the image with the recommended patches see: https://www.oracle.com/pls/topic/lookup?ctx=en/enterprise-manager&id=EMLCM-GUID-431C8AE4-774B-4DD8-89A5-A6A30B071740.
• uploadPatches: string
  Gives the information about how to get/upload the recommended patches in EM

  Example: To upload recommended patches in EM use the following command: emcli upload_patches -from_host=host_name -patch_files=metadata_file_path;ZIP_file_path [-cred_name=name -cred_owner=owner]. In online connection mode, the patches can be directly downloaded to EM as well.

{
    "description":"Message additional information about how to get and to use the recommended patches",
    "type":"object",
    "properties":{
        "uploadPatches":{
            "description":"Gives the information about how to get/upload the recommended patches in EM",
            "type":"string",
            "example":"To upload recommended patches in EM use the following command: emcli upload_patches -from_host=host_name -patch_files=metadata_file_path;ZIP_file_path [-cred_name=name -cred_owner=owner]. In online connection mode, the patches can be directly downloaded to EM as well."
        },
        "createNewVersion":{
            "description":"Gives the information about how to create the new version of image from the recommended patches",
            "type":"string",
            "example":"To create a new version of the image with the recommended patches see: https://www.oracle.com/pls/topic/lookup?ctx=en/enterprise-manager&id=EMLCM-GUID-431C8AE4-774B-4DD8-89A5-A6A30B071740."
        }
    }
}

Nested Schema : oracleRecommendedPatches

Type: object

Oracle recommended patch details

Match All

Show Source

• object PatchRecommendationDetail
  Patch details

{
    "description":"Oracle recommended patch details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationDetail"
        }
    ]
}

Nested Schema : PatchRecommendationDetail

Type: object

Patch details

Show Source

• items: array items
  Array of patches
• total: number
  Total number of patches

  Example: 10

{
    "description":"Patch details",
    "type":"object",
    "properties":{
        "total":{
            "description":"Total number of patches",
            "type":"number",
            "example":10
        },
        "items":{
            "description":"Array of patches",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/PatchRecommendationSummary"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Array of patches

Show Source

• Array of: object items

{
    "description":"Array of patches",
    "type":"array",
    "items":{
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/PatchRecommendationSummary"
            }
        ]
    }
}

Nested Schema : items

Type: object

Match All

Show Source

• object PatchRecommendationSummary
  Recommended patches for Database Gold Image Version

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationSummary"
        }
    ]
}

Nested Schema : PatchRecommendationSummary

Type: object

Recommended patches for Database Gold Image Version

Show Source

• bugs: array bugs
  List of bugs
• isSystemPatch: boolean
  flag indicates if the patch is System patch or not

  Example: true
• patchDescription: string
  Description of the Patch

  Example: OJVM RELEASE UPDATE 19.16.0.0.0
• patchId: string
  Id of the Patch

  Example: 34086870
• patchName: string
  Name of the Patch

  Example: 34086870

{
    "description":"Recommended patches for Database Gold Image Version",
    "type":"object",
    "properties":{
        "patchId":{
            "description":"Id of the Patch",
            "type":"string",
            "example":"34086870"
        },
        "patchName":{
            "description":"Name of the Patch",
            "type":"string",
            "example":"34086870"
        },
        "patchDescription":{
            "description":"Description of the Patch",
            "type":"string",
            "example":"OJVM RELEASE UPDATE 19.16.0.0.0"
        },
        "isSystemPatch":{
            "description":"flag indicates if the patch is System patch or not",
            "type":"boolean",
            "example":"true"
        },
        "bugs":{
            "description":"List of bugs",
            "type":"array",
            "items":{
                "type":"string",
                "example":"26716835,28209601,28777073,29224710,29254623,29415774,29445548,29512125,29540327,29540831,29774362,29942275,30134746,30160625,30534662,30674373,30855101,30889443,30895577,31247838,31306261,31311732,31359215,31494420,31668872,31727233,31776121,31844357,32032733,32069696,32124570,32165759,32167592,32523206,32892883,33184467,33223248,33563137,33805155,33872610,34149263"
            }
        }
    }
}

Nested Schema : bugs

Type: array

List of bugs

Show Source

• Array of: string
  Example: 26716835,28209601,28777073,29224710,29254623,29415774,29445548,29512125,29540327,29540831,29774362,29942275,30134746,30160625,30534662,30674373,30855101,30889443,30895577,31247838,31306261,31311732,31359215,31494420,31668872,31727233,31776121,31844357,32032733,32069696,32124570,32165759,32167592,32523206,32892883,33184467,33223248,33563137,33805155,33872610,34149263

{
    "description":"List of bugs",
    "type":"array",
    "items":{
        "type":"string",
        "example":"26716835,28209601,28777073,29224710,29254623,29415774,29445548,29512125,29540327,29540831,29774362,29942275,30134746,30160625,30534662,30674373,30855101,30889443,30895577,31247838,31306261,31311732,31359215,31494420,31668872,31727233,31776121,31844357,32032733,32069696,32124570,32165759,32167592,32523206,32892883,33184467,33223248,33563137,33805155,33872610,34149263"
    }
}

Examples

Select an example Patch without Bug Patch with Bugs Patches without Bugs Patches with Bugs

400 Response

Bad Request. The payload is null or missing some parameters

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized. The user does not have permissions to perform the requested operation

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested REST API URL is not found.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable. The server is unable to process the request.

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top