Jump to

• Request
• Response

Report of Patch Recommendations for Images

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/patchRecommendationsReport

Recommended patches report for all the images

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• excludeList: array excludeList
  exclude the given details in response
• limit: number
  limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)

  Example: 10
• page: string
  Base 64 encoded page

  Example: b2Zmc2V0OjA
• sort: string
  Sort field along with an optional sort direction. The supported attributes for sorting are 'imageId', 'imageName', 'imageDescription', 'targetType', 'createdBy', 'timeCreated', 'platform', 'version', 'oracleRecommendedPatchCount', 'subcribedTargetStatistics.total', 'subcribedTargetStatistics.compliantTargetCount'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.

  Example: imageName:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationsReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'imageId', 'imageName', 'imageDescription', 'targetType', 'createdBy', 'timeCreated', 'platform', 'version', 'oracleRecommendedPatchCount', 'subcribedTargetStatistics.total', 'subcribedTargetStatistics.compliantTargetCount'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"imageName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Match All

Show Source

• object PatchRecommendationsReportFilter
  Filters for the patch recommendations report

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationsReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'imageId', 'imageName', 'imageDescription', 'targetType', 'createdBy', 'timeCreated', 'platform', 'version', 'oracleRecommendedPatchCount', 'subcribedTargetStatistics.total', 'subcribedTargetStatistics.compliantTargetCount'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"imageName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":10
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

Nested Schema : excludeList

Type: array

exclude the given details in response

Show Source

• Array of: string
  Allowed Values: [ "total" ]

{
    "description":"exclude the given details in response",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "total"
        ]
    }
}

Nested Schema : PatchRecommendationsReportFilter

Type: object

Filters for the patch recommendations report

Show Source

• imageDescriptionMatches: string
  Wildcard search on the image description

  Example: image%
• imageNameMatches: string
  Wildcard search on the image name

  Example: db19%
• isCurrentVersionUptoDate: boolean
  Flag to filter images, which have current version that do not have any recommended patches
• isNonCurrentVersionUptodate: boolean
  Flag to filter images, which have non-current version that do not have any recommended patches
• platform: string
  Platform of the image

  Example: linux_x64_86
• targetTypeList: array targetTypeList
  List of target types
• versionMatches: string
  Wildcard search on the image version

  Example: 19.14%

{
    "description":"Filters for the patch recommendations report",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"List of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "imageNameMatches":{
            "description":"Wildcard search on the image name",
            "type":"string",
            "example":"db19%"
        },
        "imageDescriptionMatches":{
            "description":"Wildcard search on the image description",
            "type":"string",
            "example":"image%"
        },
        "versionMatches":{
            "description":"Wildcard search on the image version",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the image",
            "type":"string",
            "example":"linux_x64_86"
        },
        "isCurrentVersionUptoDate":{
            "description":"Flag to filter images, which have current version that do not have any recommended patches",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag to filter images, which have non-current version that do not have any recommended patches",
            "type":"boolean"
        }
    }
}

Nested Schema : targetTypeList

Type: array

List of target types

Show Source

• Array of:
  Allowed Values: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"List of target types",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

Examples

Select an example Filter on Target properties and exclude 'total'

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. Patch recommendation report details retrieved.

Body ()

Root Schema : schema

Type: object

Match All

Show Source

• object GoldImagePatchRecommendationsReport
  Image details

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

Nested Schema : GoldImagePatchRecommendationsReport

Type: object

Image details

Show Source

• count: number
  count of subscribed targets in the current fetch

  Example: 10
• currentPage: string
  Base 64 encoded current page

  Example: b2Zmc2V0OjA
• items: array items
  list of targets
• nextPage: string
  Base 64 encoded next page

  Example: b2Zmc2V0OjA
• previousPage: string
  Base 64 encoded previous page

  Example: b2Zmc2V0OjA
• total: number
  Total count of targets subscribed to images

  Example: 100

{
    "description":"Image details",
    "type":"object",
    "properties":{
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets subscribed to images",
            "type":"number",
            "example":100
        },
        "count":{
            "description":"count of subscribed targets in the current fetch",
            "type":"number",
            "example":10
        },
        "items":{
            "description":"list of targets",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/PatchRecommendationReportSummary"
                    }
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

list of targets

Show Source

• Array of: items

{
    "description":"list of targets",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/PatchRecommendationReportSummary"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object PatchRecommendationReportSummary
  Summary of image with Patch recommendation report

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationReportSummary"
        }
    ]
}

Nested Schema : PatchRecommendationReportSummary

Type: object

Summary of image with Patch recommendation report

Show Source

• createdBy: string
  Owner of Gold Image

  Example: SYSMAN
• currentVersionDescription: string
  Description of the current version of image

  Example: 19c RU14 image
• currentVersionName: string
  Name of the current version of image

  Example: version05
• imageDescription: string
  Base 64 encoded previous page

  Example: database image with version 19.14
• imageId: string
  Id of the image

  Example: F444A18141937212E05380FE4564170A
• imageName: string
  Name of the image

  Example: db19_14
• isCurrentVersionUptoDate: boolean
  Flag indicates if the current version of image does not have recommended patches
• isFppImage: boolean
  Flag indicate if the image is FPP
• isNonCurrentVersionUptodate: boolean
  Flag indicates if the non-current version of image does not have recommended patches
• platform: string
  Platform for the image

  Example: linux_x64_86
• recommendedPatchCount: number
  Count of recommended patches

  Example: 5
• subcribedTargetStatistics: object subcribedTargetStatistics
  Statistics of the subscribed targets
• targetType: string
  Target type of image

  Example: oracle_database
• timeCreated: string (date-time)
  Creation time of the Gold Image

  Example: 2022-08-22 00:10:27.0
• uptodateNonCurrentImageVersionName: string
  When isNonCurrentVersionUptodate flag is true, this field contains uptodate noncurrent image version name

  Example: version5
• version: string
  Version the of the image

  Example: 19.14.0.0.0

{
    "description":"Summary of image with Patch recommendation report",
    "type":"object",
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"F444A18141937212E05380FE4564170A"
        },
        "imageName":{
            "description":"Name of the image",
            "type":"string",
            "example":"db19_14"
        },
        "imageDescription":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"database image with version 19.14"
        },
        "isFppImage":{
            "description":"Flag indicate if the image is FPP",
            "type":"boolean"
        },
        "version":{
            "description":"Version the of the image",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "currentVersionName":{
            "description":"Name of the current version of image",
            "type":"string",
            "example":"version05"
        },
        "currentVersionDescription":{
            "description":"Description of the current version of image",
            "type":"string",
            "example":"19c RU14 image"
        },
        "targetType":{
            "description":"Target type of image",
            "type":"string",
            "example":"oracle_database"
        },
        "platform":{
            "description":"Platform for the image",
            "type":"string",
            "example":"linux_x64_86"
        },
        "timeCreated":{
            "description":"Creation time of the Gold Image",
            "type":"string",
            "format":"date-time",
            "example":"2022-08-22 00:10:27.0"
        },
        "createdBy":{
            "description":"Owner of Gold Image",
            "type":"string",
            "example":"SYSMAN"
        },
        "isCurrentVersionUptoDate":{
            "description":"Flag indicates if the current version of image does not have recommended patches",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if the non-current version of image does not have recommended patches",
            "type":"boolean"
        },
        "uptodateNonCurrentImageVersionName":{
            "description":"When isNonCurrentVersionUptodate flag is true, this field contains uptodate noncurrent image version name",
            "type":"string",
            "example":"version5"
        },
        "recommendedPatchCount":{
            "description":"Count of recommended patches",
            "type":"number",
            "example":5
        },
        "subcribedTargetStatistics":{
            "description":"Statistics of the subscribed targets",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/SubscribedTargetStatistics"
                }
            ]
        }
    }
}

Nested Schema : subcribedTargetStatistics

Type: object

Statistics of the subscribed targets

Match All

Statistics of the subscribed targets

Show Source

• object SubscribedTargetStatistics
  Statistics of the subscribed targets

{
    "description":"Statistics of the subscribed targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/SubscribedTargetStatistics"
        }
    ]
}

Nested Schema : SubscribedTargetStatistics

Type: object

Statistics of the subscribed targets

Show Source

• compliantTargetCount: number
  Count of compliant targets

  Example: 95
• containedPdbCount: number
  Count of contained PDBs count

  Example: 20
• total: number
  Count of total subscribed targets

  Example: 100

{
    "description":"Statistics of the subscribed targets",
    "type":"object",
    "properties":{
        "total":{
            "description":"Count of total subscribed targets",
            "type":"number",
            "example":100
        },
        "containedPdbCount":{
            "description":"Count of contained PDBs count",
            "type":"number",
            "example":20
        },
        "compliantTargetCount":{
            "description":"Count of compliant targets",
            "type":"number",
            "example":95
        }
    }
}

Examples

Select an example Filter on Target properties and exclude 'total'

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top