Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
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.
// {
// "availabilityDomain": "dolore ut",
// "compartmentId": "{{compartment_ocid}}",
// "sourceDetails": {
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "backupPolicyId": "sunt irure aliqua enim",
// "definedTags": {},
// "displayName": "veniam aute incididunt labore",
// "freeformTags": {}
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"availabilityDomain",L"dolore ut");
CkJsonObjectW_UpdateString(json,L"compartmentId",L"{{compartment_ocid}}");
CkJsonObjectW_UpdateString(json,L"sourceDetails.type.value",L"<Error: Too many levels of nesting to fake this schema>");
CkJsonObjectW_UpdateString(json,L"backupPolicyId",L"sunt irure aliqua enim");
CkJsonObjectW_UpdateNewObject(json,L"definedTags");
CkJsonObjectW_UpdateString(json,L"displayName",L"veniam aute incididunt labore");
CkJsonObjectW_UpdateNewObject(json,L"freeformTags");
CkHttpW_SetRequestHeader(http,L"opc-retry-token",L"aliqua enim i");
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}}");
resp = CkHttpW_PostJson3(http,L"https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
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(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(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-H "opc-retry-token: aliqua enim i"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"availabilityDomain": "dolore ut",
"compartmentId": "{{compartment_ocid}}",
"sourceDetails": {
"type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"backupPolicyId": "sunt irure aliqua enim",
"definedTags": {},
"displayName": "veniam aute incididunt labore",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups
Postman Collection Item JSON
{
"name": "CreateVolumeGroup",
"request": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
},
{
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
},
"description": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
},
"response": [
{
"name": "The volume group is being created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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}"
}
]
}
