Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *strVal;
const wchar_t *id;
const wchar_t *availabilityDomain;
const wchar_t *displayName;
int sizeInMBs;
const wchar_t *compartmentId;
const wchar_t *timeCreated;
const wchar_t *lifecycleState;
BOOL isHydrated;
int sizeInGBs;
const wchar_t *Value;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_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": "non aute",
// "freeformTags": {},
// "volumeIds": [
// "dolore cupidatat qui sint",
// "non est qui"
// ]
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateNewObject(json,L"definedTags");
CkJsonObjectW_UpdateString(json,L"displayName",L"non aute");
CkJsonObjectW_UpdateNewObject(json,L"freeformTags");
CkJsonObjectW_UpdateString(json,L"volumeIds[0]",L"dolore cupidatat qui sint");
CkJsonObjectW_UpdateString(json,L"volumeIds[1]",L"non est qui");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"x-content-sha256",L"{{content_sha256}}");
CkHttpW_SetRequestHeader(http,L"Authorization",L"{{signature}}");
CkHttpW_SetRequestHeader(http,L"Date",L"{{date}}");
CkHttpW_SetRequestHeader(http,L"if-match",L"officia sed");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups/:volumeGroupId",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "voluptate veniam culpa",
// "volumeIds": [
// "et proident minim",
// "id aliquip"
// ],
// "availabilityDomain": "Excepteur",
// "displayName": "esse",
// "sizeInMBs": -79372556,
// "compartmentId": "exercitation",
// "timeCreated": "1975-12-22T14:06:08.177Z",
// "lifecycleState": "AVAILABLE",
// "definedTags": {},
// "freeformTags": {},
// "isHydrated": false,
// "sizeInGBs": 2892595,
// "sourceDetails": {
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// }
// 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 = CkJsonObjectW_stringOf(jResp,L"id");
availabilityDomain = CkJsonObjectW_stringOf(jResp,L"availabilityDomain");
displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
sizeInMBs = CkJsonObjectW_IntOf(jResp,L"sizeInMBs");
compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
isHydrated = CkJsonObjectW_BoolOf(jResp,L"isHydrated");
sizeInGBs = CkJsonObjectW_IntOf(jResp,L"sizeInGBs");
Value = CkJsonObjectW_stringOf(jResp,L"sourceDetails.type.value");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"volumeIds");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"volumeIds[i]");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_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": "non aute",
"freeformTags": {},
"volumeIds": [
"dolore cupidatat qui sint",
"non est qui"
]
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups/:volumeGroupId
Postman Collection Item JSON
{
"name": "UpdateVolumeGroup",
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId",
"value": "officia sed",
"description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
}
]
},
"description": "Updates the set of volumes in a volume group along with the display name. Use this operation\nto add or remove volumes in a volume group. Specify the full list of volume IDs to include in the\nvolume group. If the volume ID is not specified in the call, it will be removed from the volume group.\nAvoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
},
"response": [
{
"name": "The volume group 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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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 \"id\": \"voluptate veniam culpa\",\n \"volumeIds\": [\n \"et proident minim\",\n \"id aliquip\"\n ],\n \"availabilityDomain\": \"Excepteur\",\n \"displayName\": \"esse\",\n \"sizeInMBs\": -79372556,\n \"compartmentId\": \"exercitation\",\n \"timeCreated\": \"1975-12-22T14:06:08.177Z\",\n \"lifecycleState\": \"AVAILABLE\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isHydrated\": false,\n \"sizeInGBs\": 2892595,\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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\": \"non aute\",\n \"freeformTags\": {},\n \"volumeIds\": [\n \"dolore cupidatat qui sint\",\n \"non est qui\"\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups/:volumeGroupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups",
":volumeGroupId"
],
"variable": [
{
"key": "volumeGroupId"
}
]
}
},
"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}"
}
]
}
