Jump to

• Request
• Response

Check Applicability of Image

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/checkApplicability

Checks whether the image can be used to patch a specified list of targets. This is done by comparing the bug fixes available in the current Oracle home of the target and the image.

Request

Path Parameters

• goldImageId(required): string
  ID of the image

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Match All

Show Source

• object TargetList
  List of targets

{
    "type":"object",
    "required":[
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        }
    ]
}

Nested Schema : TargetList

Type: object

List of targets

Show Source

• targetList: array targetList
  Array of target names
• targetType: string
  Target type

  Example: oracle_database

{
    "description":"List of targets",
    "type":"object",
    "properties":{
        "targetList":{
            "description":"Array of target names",
            "type":"array",
            "items":{
                "type":"string",
                "example":"db1, db2"
            }
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

Nested Schema : targetList

Type: array

Array of target names

Show Source

• Array of: string
  Example: db1, db2

{
    "description":"Array of target names",
    "type":"array",
    "items":{
        "type":"string",
        "example":"db1, db2"
    }
}

Examples

Select an example Payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Ok. Summary of applicability of image to given targets.

Body ()

Root Schema : GoldImageCheckApplicability

Type: array

Applicability of image to target

Show Source

• Array of: object items

{
    "description":"Applicability of image to target",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/PatchCollection"
            }
        ],
        "type":"object",
        "properties":{
            "isApplicable":{
                "description":"Flag to indicate applicability",
                "type":"boolean"
            },
            "targetId":{
                "description":"ID of target",
                "type":"string",
                "example":"E2B6E94B9DBC2FE3E05342104B64A9DE"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• isApplicable: boolean
  Flag to indicate applicability
• targetId: string
  ID of target

  Example: E2B6E94B9DBC2FE3E05342104B64A9DE

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchCollection"
        }
    ],
    "type":"object",
    "properties":{
        "isApplicable":{
            "description":"Flag to indicate applicability",
            "type":"boolean"
        },
        "targetId":{
            "description":"ID of target",
            "type":"string",
            "example":"E2B6E94B9DBC2FE3E05342104B64A9DE"
        }
    }
}

Match All

Show Source

• object allOf PatchCollection
  Patches and bug fixes (if requested) for the specified version of the image

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchCollection"
        }
    ],
    "type":"object",
    "properties":{
        "isApplicable":{
            "description":"Flag to indicate applicability",
            "type":"boolean"
        },
        "targetId":{
            "description":"ID of target",
            "type":"string",
            "example":"E2B6E94B9DBC2FE3E05342104B64A9DE"
        }
    }
}

Nested Schema : PatchCollection

Type: object

Patches and bug fixes (if requested) for the specified version of the image

Match All

Patches and bug fixes (if requested) for the specified version of the image

Patches and bug fixes (if requested) for the specified version of the image

Show Source

• object ImagePatchCollection
  Patches available in the image
• object ImageBugCollection
  Collection of the image bugs

{
    "description":"Patches and bug fixes (if requested) for the specified version of the image",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ImagePatchCollection"
        },
        {
            "$ref":"#/components/schemas/ImageBugCollection"
        }
    ]
}

Nested Schema : ImagePatchCollection

Type: object

Patches available in the image

Show Source

• patches: array patches
  Array of patches
• totalPatches: integer
  Total count of patches in the image

{
    "description":"Patches available in the image",
    "type":"object",
    "properties":{
        "totalPatches":{
            "description":"Total count of patches in the image",
            "type":"integer"
        },
        "patches":{
            "description":"Array of patches",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImagePatch"
            }
        }
    }
}

Nested Schema : ImageBugCollection

Type: object

Collection of the image bugs

Show Source

• bugs: array bugs
  Bug details
• totalBugs: integer
  Total count of bugs in the image

{
    "description":"Collection of the image bugs",
    "type":"object",
    "properties":{
        "totalBugs":{
            "description":"Total count of bugs in the image",
            "type":"integer"
        },
        "bugs":{
            "description":"Bug details",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImageBug"
            }
        }
    }
}

Nested Schema : patches

Type: array

Array of patches

Show Source

• Array of: object ImagePatch
  Image patch details

{
    "description":"Array of patches",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImagePatch"
    }
}

Nested Schema : ImagePatch

Type: object

Image patch details

Show Source

• patchDescription: string
  Description of the patch

  Example: Database Release Update : 19.14.0.0.220118 (33515361)
• patchId: string
  ID of the patch

  Example: 33515361

{
    "description":"Image patch details",
    "type":"object",
    "properties":{
        "patchId":{
            "description":"ID of the patch",
            "type":"string",
            "example":"33515361"
        },
        "patchDescription":{
            "description":"Description of the patch",
            "type":"string",
            "example":"Database Release Update : 19.14.0.0.220118 (33515361)"
        }
    }
}

Nested Schema : bugs

Type: array

Bug details

Show Source

• Array of: object ImageBug
  Image bug details

{
    "description":"Bug details",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImageBug"
    }
}

Nested Schema : ImageBug

Type: object

Image bug details

Show Source

• bugDescription: string
  Description of a bug

  Example: DBA_REGISTRY_HISTORY IS NOT UPDATED DURING UPGRADE TO 12.1.0.2
• bugNumber: string
  Bug number

  Example: 19134173
• patchId: string
  ID of Patch

  Example: 33515361
• patchUpi: string
  Patch UPI

{
    "description":"Image bug details",
    "type":"object",
    "properties":{
        "bugNumber":{
            "description":"Bug number",
            "type":"string",
            "example":"19134173"
        },
        "patchId":{
            "description":"ID of Patch",
            "type":"string",
            "example":"33515361"
        },
        "patchUpi":{
            "description":"Patch UPI",
            "type":"string"
        },
        "bugDescription":{
            "description":"Description of a bug",
            "type":"string",
            "example":"DBA_REGISTRY_HISTORY IS NOT UPDATED DURING UPGRADE TO 12.1.0.2"
        }
    }
}

Examples

Select an example Payload of Applicable Payload of Applicable and Image has more bug fixes Payload of Not Applicable Payload of Upgrade

401 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal Server Error. Exception in execution of REST API.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

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

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top