View All Patching Precheck Operations
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/patches/checks
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
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
array
-
Array of:
object view-precheck
The response body includes information about the patch precheck. When viewing all patching prechecks, the response body includes information about all patch prechecks executed on this service instance.
object
-
endDate(optional):
string
Date and time that the patching precheck operation stopped.
-
href(optional):
string
URL for checking the status of the patching precheck job. This attribute displays only when viewing all patching precheck operations.
-
id(optional):
integer
ID of the operation.
-
inProgress(optional):
boolean
Flag that specifies whether the patch precheck is still in progress.
-
jobId(optional):
string
Job ID for the patching precheck operation.
-
jsonResult(optional):
string
System messages. This attribute displays only when viewing the status of one patching precheck operation.
-
patchId(optional):
string
Patch ID.
-
performedBy(optional):
string
Name of the user account used to perform the patch precheck.
-
preCheckMessages(optional):
array preCheckMessages
List of precheck messages. No messages are returned when the precheck completes successfully.
-
precheckResultItems(optional):
array precheckResultItems
List of precheck result items. No items are returned when the precheck completes successfully.
-
startDate(optional):
string
Date and time that the patching precheck operation started.
-
status(optional):
string
Status of the patching precheck operation. Examples include:
IN_PROGRESS
- Operation still in progress.PASSED_PRECHECK
- Patching precheck passed.DIDNT_PASS_PRECHECK
- Patching precheck did not pass.DIDNT_FINISHED_PRECHECK
- An internal error was encountered and the patching precheck could not be performed.
-
statusMessage(optional):
string
Last status message for the completed operation.
array
array
Examples
The following example shows how to view all patching precheck operations 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/checks
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: Fri, 05 May 2017 23:02:36 GMT
Example of Response Body
The following shows an example of the response body in JSON format.
[
{
"id":2001,
"jobId":"4853126",
"patchId":"Patch_12.1.3.0.6",
"startDate":"2017-05-05T22:56:44.431+0000",
"endDate":"2017-05-05T22:58:37.953+0000"
"performedBy":"username",
"inProgress":false,
"status":"PASSED_PRECHECK",
"href":"https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/patches/checks/job/4853126",
"preCheckMessages":[],
"statusMessage":"Completed"
},
{
"id":1952,
"jobId":"4786564",
"patchId":"otd_jdk1.7.0_95",
"startDate":"2017-05-03T21:34:14.859+0000",
"endDate":"2017-05-03T21:36:08.951+0000"
"performedBy":"username",
"inProgress":false,
"status":"PASSED_PRECHECK",
"href":"https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/patches/checks/job/4786564",
"preCheckMessages":[],
"statusMessage":"Completed"
}
]