Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *displayName;
const char *compartmentId;
const char *timeCreated;
const char *lifecycleState;
const char *bootVolumeId;
const char *expirationTime;
const char *imageId;
const char *kmsKeyId;
int sizeInGBs;
const char *sourceBootVolumeBackupId;
const char *sourceType;
const char *timeRequestReceived;
const char *v_type;
int uniqueSizeInGBs;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "definedTags": {},
// "displayName": "cillum aute voluptate consectetur",
// "freeformTags": {}
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateNewObject(json,"definedTags");
CkJsonObject_UpdateString(json,"displayName","cillum aute voluptate consectetur");
CkJsonObject_UpdateNewObject(json,"freeformTags");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"x-content-sha256","{{content_sha256}}");
CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
CkHttp_SetRequestHeader(http,"Date","{{date}}");
CkHttp_SetRequestHeader(http,"if-match","officia sed");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups/:bootVolumeBackupId",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "reprehenderit dolore irure elit",
// "displayName": "ex culpa",
// "compartmentId": "tempor exercitation commodo cillum",
// "timeCreated": "1981-07-30T00:01:31.556Z",
// "lifecycleState": "TERMINATED",
// "bootVolumeId": "dolore culpa sint",
// "definedTags": {},
// "expirationTime": "1947-05-09T22:23:58.728Z",
// "freeformTags": {},
// "imageId": "magna ipsum nisi in",
// "kmsKeyId": "tempor veniam deserunt",
// "sizeInGBs": 8220,
// "sourceBootVolumeBackupId": "consequat sit dolore",
// "sourceType": "MANUAL",
// "timeRequestReceived": "1959-02-03T20:49:53.527Z",
// "type": "INCREMENTAL",
// "uniqueSizeInGBs": 2985
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
id = CkJsonObject_stringOf(jResp,"id");
displayName = CkJsonObject_stringOf(jResp,"displayName");
compartmentId = CkJsonObject_stringOf(jResp,"compartmentId");
timeCreated = CkJsonObject_stringOf(jResp,"timeCreated");
lifecycleState = CkJsonObject_stringOf(jResp,"lifecycleState");
bootVolumeId = CkJsonObject_stringOf(jResp,"bootVolumeId");
expirationTime = CkJsonObject_stringOf(jResp,"expirationTime");
imageId = CkJsonObject_stringOf(jResp,"imageId");
kmsKeyId = CkJsonObject_stringOf(jResp,"kmsKeyId");
sizeInGBs = CkJsonObject_IntOf(jResp,"sizeInGBs");
sourceBootVolumeBackupId = CkJsonObject_stringOf(jResp,"sourceBootVolumeBackupId");
sourceType = CkJsonObject_stringOf(jResp,"sourceType");
timeRequestReceived = CkJsonObject_stringOf(jResp,"timeRequestReceived");
v_type = CkJsonObject_stringOf(jResp,"type");
uniqueSizeInGBs = CkJsonObject_IntOf(jResp,"uniqueSizeInGBs");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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 '{
"definedTags": {},
"displayName": "cillum aute voluptate consectetur",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups/:bootVolumeBackupId
Postman Collection Item JSON
{
"name": "UpdateBootVolumeBackup",
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId",
"value": "officia sed",
"description": "(Required) The OCID of the boot volume backup."
}
]
},
"description": "Updates the display name for the specified boot volume backup.\nAvoid entering confidential information.\n"
},
"response": [
{
"name": "The boot volume backup 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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "etag",
"value": "officia sed",
"description": "For optimistic concurrency control. See `if-match`.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"reprehenderit dolore irure elit\",\n \"displayName\": \"ex culpa\",\n \"compartmentId\": \"tempor exercitation commodo cillum\",\n \"timeCreated\": \"1981-07-30T00:01:31.556Z\",\n \"lifecycleState\": \"TERMINATED\",\n \"bootVolumeId\": \"dolore culpa sint\",\n \"definedTags\": {},\n \"expirationTime\": \"1947-05-09T22:23:58.728Z\",\n \"freeformTags\": {},\n \"imageId\": \"magna ipsum nisi in\",\n \"kmsKeyId\": \"tempor veniam deserunt\",\n \"sizeInGBs\": 8220,\n \"sourceBootVolumeBackupId\": \"consequat sit dolore\",\n \"sourceType\": \"MANUAL\",\n \"timeRequestReceived\": \"1959-02-03T20:49:53.527Z\",\n \"type\": \"INCREMENTAL\",\n \"uniqueSizeInGBs\": 2985\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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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": "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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups",
":bootVolumeBackupId"
],
"variable": [
{
"key": "bootVolumeBackupId"
}
]
}
},
"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}"
}
]
}
