1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Patches

View Available Patches

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/available

Returns a list of all available patches for an Oracle Java Cloud Service instance.

Note: Patching is not supported for Oracle Java Cloud Service instances if you have installed any product that modifies MW_HOME (such as Oracle WebCenter Portal and Oracle Data Integrator). Patching is also not supported if you are reusing a license via the Bring Your Own License (BYOL) entitlement (for any product that modifies MW_HOME). Because patching replaces the contents of MW_HOME, patching prechecks flag this condition and patching fails.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : available-patches-response
Type: array
The response body contains information about patches that can be applied, if any are available.
Show Source
  • available-patches
    Each object contains information about a patch. A patch with a patchCategory value of MajorPatch is a WebLogic Server software version upgrade patch.
Nested Schema : available-patches
Type: object
Each object contains information about a patch. A patch with a patchCategory value of MajorPatch is a WebLogic Server software version upgrade patch.
Show Source
Nested Schema : availablePatchGuiMetadata
Type: object
Instruction to the metadata UI about the patch.
Show Source
Nested Schema : componentPatches
Type: object
A map that groups details of one or more components in the patch. A component could be WLS, OTD, JDK, OTD_JDK, or ORACLE_TOOLS.
Show Source
Nested Schema : lastprePreCheckResult
Type: object
Groups information about the last precheck operation. This attribute is displayed only when a precheck has been performed on a patch.
Show Source
Nested Schema : patchCustomActions
Type: array
List of custom actions during the patching process.
Show Source
Nested Schema : componentname
Type: object
This attribute is the actual component name for the target service type. For example, an Oracle Java Cloud Service component name could be WLS. Each object is one component.
Show Source
Nested Schema : zipBundles
Type: object
Zips that contain the artifacts for patching target components (for example, patched binaries or patches for the service volumes).
Show Source
Nested Schema : artifactname
Type: object
This attribute is the actual artifact name for the target service type, component, and component version (for example, JDK or WLS). Each object is one artifact.
Show Source
Nested Schema : preCheckMessages
Type: array
List of patching precheck messages. No patching precheck messages are returned when the precheck completes successfully.
Show Source
Back to Top

Examples

The following example shows how to view available patches for an Oracle Java Cloud Service instance by submitting a GET request on the REST resource using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/patches/available

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Language: en
Content-Type: application/json
Date: Thu, 11 May 2017 17:02:53 GMT

Example of Response Body

The following is an example of a response body where a WebLogic Server Patch Set Update (PSU) is available for patching.

[
    {
        "availablePatchGuiMetadata": {
            "supportsPreCheck": true
        },
        "lastprePreCheckResult": {
            "id": 20316,
            "jobId": "23786904",
            "patchId": "wls_patch_12.2.1.2.2_180120",
            "jsonResult": "{\"resultMessage\":\"No errors\",\"messages\":[]}",
            "startDate": "2018-03-27T18:34:29.984+0000",
            "endDate": "2018-03-27T18:36:40.561+0000",
            "performedBy": "username",
            "inProgress": false,
            "status": "PASSED_PRECHECK",
            "preCheckMessages": [],
            "statusMessage": "No errors"
        },
        "patchId": "wls_patch_12.2.1.2.2_180120",
        "patchCategory": "PATCH",
        "patchSeverity": "Normal",
        "includesConfigUpgrade": false,
        "patchDescription": "WLS PIPELINE UPDATE 12.2.1.2.2",
        "patchReleaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId=26860993",
        "serviceType": "JaaS",
        "serviceVersion": "12cRelease212",
        "releaseDate": "2018-01-20T01:40:00.000+0000",
        "entryDate": "2018-05-10T20:08:47.835+0000",
        "entryUserId": "smctl",
        "componentPatches": {
            "WLS": {
                "id": 12902,
                "version": "12.2.1.2.8",
                "releaseVersion": "12.2.1.2.180120",
                "expectedAppliedPatches": "opatch:19795066,19154304,18905788,19632480,19030178,22754279,19002423,21663638",
                "zipBundles": {
                    "JDK": {
                        "id": 62472,
                        "md5sum": "51c0768028b642cf3a37bfdb72550c3a",
                        "storageKey": "jcs/JDK/8.0.161/180116/jdk.zip",
                        "zipVersion": "1.8.0_161",
                        "releaseDate": "2018-01-16",
                        "releaseUrl": "http://www.oracle.com/technetwork/java/javase/8all-relnotes-2226344.html#R180_161",
                        "displayName": "JDK"
                    },
                    "WLS": {
                        "id": 62473,
                        "md5sum": "09ea08d07b8e097ac36e026c25128a77",
                        "storageKey": "jcs/FMW/12.2.1.2.2/180119/fmiddleware.zip",
                        "releaseDate": "2018-01-20",
                        "releaseUrl": "https://support.oracle.com/epmos/faces/PatchDetail?patchId=26860993",
                        "displayName": "Middleware"
                    }
                },
                "preserveFiles": []
            },
            "OTD": {
                "id": 12901,
                "version": "12.2.1.2.4",
                "releaseVersion": "12.2.1.2.180116",
                "zipBundles": {
                    "OTD_JDK": {
                        "id": 62471,
                        "md5sum": "51c0768028b642cf3a37bfdb72550c3a",
                        "storageKey": "jcs/JDK/8.0.161/180116/jdk.zip",
                        "zipVersion": "1.8.0_161",
                        "releaseDate": "2018-01-16",
                        "releaseUrl": "http://www.oracle.com/technetwork/java/javase/8all-relnotes-2226344.html#R180_161",
                        "displayName": "OTD JDK"
                    }
                },
                "preserveFiles": []
            }
        },
        "patchType": "PSU",
        "requiresRestart": true,
        "serviceTypeVersions": "ANY",
        "isDeleted": false,
        "displayName": "12.2.1.2.180120",
        "supportedStrategy": "Rolling",
        "releaseVersion": "12.2.1.2.180120",
        "patchCustomActions": [],
        "restartStrategy": "RESTART_AFTER_PATCH",
        "isUpgrade": false
    }
]

The following is an example of a response body where a WebLogic Server software version upgrade patch is available for patching (indicated by MajorPatch in patchCategory). 

[{
   "availablePatchGuiMetadata":{
      "supportsPreCheck":true
   },
   "patchId":"wls_upg_12.2.1.3.190115_for_12cRelease212",
   "patchCategory":"MajorPatch",
   "patchSeverity":"Normal",
   "includesConfigUpgrade":false,
   "patchDescription":"WebLogic Server 12.2.1.3.0 with PSU Update 12.2.1.3.190115",
   "patchReleaseUrl":"https://support.oracle.com/epmos/faces/PatchDetail?patchId\u003d28710939",
   "serviceType":"JaaS",
   "serviceVersion":"12cRelease212",
   "releaseDate":"2019-01-14T17:40:00.000+0000",
   "entryDate":"2019-02-05T12:04:51.975+0000",
   "entryUserId":"smctl",
   "componentPatches":{

   },
   "patchType":"PSU",
   "requiresRestart":false,
   "isDeleted":false,
   "displayName":"12.2.1.3.190115",
   "releaseVersion":"12.2.1.3.190115",
   "patchCustomActions":[

   ],
   "restartStrategy":"RESTART_AFTER_PATCH",
   "isUpgrade":true,
   "extensionId":0
}]
Back to Top