Modify Resources Using PATCH Requests

Language:

Use a PATCH request to modify an Oracle ILOM resource.

Note - A list of modifiable properties for each Oracle ILOM resource is available from the Swagger model under the patch->responses->schema->properties description section. For more details about the Swagger model, see Discovering Management Resources.

Request Format

PATCH <Resource_Path> HTTP/1.1
<Header Name> : <Header Value>

<Request Body>

Where:
- Request Body – Each HTTP PATCH request must specify a <request body> to indicate which property and value needs to be modified under the target resource.

Request Header Fields Required

The required request header fields are as follows: Authorization, Content-Type, and Host.

For a description of these required header fields, see Common Request Header Fields.

Response Status Codes

Success: HTTP Status = 200 OK, JSON formatted response body
Failure: HTTP Status = 4xx, 5xx, JSON formatted error response body.

Response Body

Upon modifying the data sent by the client, the Oracle ILOM REST API returns the following response body for all PATCH requests:

{
  "code": <integer code>,
  "description": "description string"
}

The value assigned to <integer code> can be any of the following:

0: PATCH operation completed with no significant consequence
1: PATCH operation completed might cause the web server to reset.
2: PATCH operation completed will cause the Oracle ILOM network connection to be disabled.

Example: HTTP Request

In the following HTTP example, a PATCH request is sent to the server SP to modify the system_contact and system_location properties under the /SP resource.

PATCH /SP HTTP/1.1
Content-Type: application/json

{"system_contact":"Mr. Smith",
 "system_location":"Newtown, MA"}

Upon successfully modifying the system properties under the /SP resource, the Oracle ILOM REST API returns the following details in a JSON response body format.

{
  "code": 0,
    "description": "PATH Action Complete"
}