Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "cpeDeviceShapeId": "Ut",
// "definedTags": {},
// "displayName": "do aute",
// "freeformTags": {}
// }
$json = new CkJsonObject();
$json->UpdateString('cpeDeviceShapeId','Ut');
$json->UpdateNewObject('definedTags');
$json->UpdateString('displayName','do aute');
$json->UpdateNewObject('freeformTags');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-content-sha256','{{content_sha256}}');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
$http->SetRequestHeader('if-match','officia sed');
$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://iaas.{{region}}.oraclecloud.com/20160918/cpes/:cpeId',$sbRequestBody,'utf-8','application/json',false,false);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "compartmentId": "ut commodo enim aute consectetur",
// "id": "incididunt anim",
// "ipAddress": "dolore consectetur",
// "cpeDeviceShapeId": "eiusmod laborum proi",
// "definedTags": {},
// "displayName": "tempor sint et pariatur",
// "freeformTags": {},
// "timeCreated": "1948-01-11T13:26:43.224Z"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$compartmentId = $jResp->stringOf('compartmentId');
$id = $jResp->stringOf('id');
$ipAddress = $jResp->stringOf('ipAddress');
$cpeDeviceShapeId = $jResp->stringOf('cpeDeviceShapeId');
$displayName = $jResp->stringOf('displayName');
$timeCreated = $jResp->stringOf('timeCreated');
?>
Curl Command
curl -X PUT
-H "if-match: officia sed"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"cpeDeviceShapeId": "Ut",
"definedTags": {},
"displayName": "do aute",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/cpes/:cpeId
Postman Collection Item JSON
{
"name": "UpdateCpe",
"request": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
},
{
"key": "x-content-sha256",
"value": "{{content_sha256}}",
"description": "(Required) Content sha256 for POST, PUT and PATCH operations",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
}
]
},
"description": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n"
},
"response": [
{
"name": "The CPE was updated.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "etag",
"value": "officia sed",
"description": "For optimistic concurrency control. See `if-match`.\n"
},
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"compartmentId\": \"ut commodo enim aute consectetur\",\n \"id\": \"incididunt anim\",\n \"ipAddress\": \"dolore consectetur\",\n \"cpeDeviceShapeId\": \"eiusmod laborum proi\",\n \"definedTags\": {},\n \"displayName\": \"tempor sint et pariatur\",\n \"freeformTags\": {},\n \"timeCreated\": \"1948-01-11T13:26:43.224Z\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Conflict",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Precondition Failed",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
},
{
"name": "An error has occurred.",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "officia sed",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
}
]
}
