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 *compartmentId;
const wchar_t *cidrBlock;
const wchar_t *lifecycleState;
const wchar_t *vcnId;
const wchar_t *availabilityDomain;
const wchar_t *displayName;
const wchar_t *routeTableId;
const wchar_t *timeCreated;
int vlanTag;
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": "laboris tempor",
// "freeformTags": {},
// "nsgIds": [
// "culpa in",
// "do mollit dolore"
// ],
// "routeTableId": "ipsum ullamco Excepteur ut cillum"
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateNewObject(json,L"definedTags");
CkJsonObjectW_UpdateString(json,L"displayName",L"laboris tempor");
CkJsonObjectW_UpdateNewObject(json,L"freeformTags");
CkJsonObjectW_UpdateString(json,L"nsgIds[0]",L"culpa in");
CkJsonObjectW_UpdateString(json,L"nsgIds[1]",L"do mollit dolore");
CkJsonObjectW_UpdateString(json,L"routeTableId",L"ipsum ullamco Excepteur ut cillum");
CkHttpW_SetRequestHeader(http,L"opc-request-id",L"8wF");
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/vlans/:vlanId",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": "magna in Lorem",
// "compartmentId": "amet ut quis",
// "cidrBlock": "consequat non",
// "lifecycleState": "AVAILABLE",
// "vcnId": "sit consectetur Ut qui",
// "availabilityDomain": "ea sunt officia mollit",
// "definedTags": {},
// "displayName": "ullamco magna eu",
// "freeformTags": {},
// "nsgIds": [
// "ad amet exercitation",
// "ut irure magna"
// ],
// "routeTableId": "sunt occaecat exercitation mollit",
// "timeCreated": "1974-12-31T12:49:21.840Z",
// "vlanTag": -19036463
// }
// 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");
compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
cidrBlock = CkJsonObjectW_stringOf(jResp,L"cidrBlock");
lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
vcnId = CkJsonObjectW_stringOf(jResp,L"vcnId");
availabilityDomain = CkJsonObjectW_stringOf(jResp,L"availabilityDomain");
displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
routeTableId = CkJsonObjectW_stringOf(jResp,L"routeTableId");
timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
vlanTag = CkJsonObjectW_IntOf(jResp,L"vlanTag");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"nsgIds");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"nsgIds[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 "opc-request-id: 8wF"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"definedTags": {},
"displayName": "laboris tempor",
"freeformTags": {},
"nsgIds": [
"culpa in",
"do mollit dolore"
],
"routeTableId": "ipsum ullamco Excepteur ut cillum"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/vlans/:vlanId
Postman Collection Item JSON
{
"name": "UpdateVlan",
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
},
{
"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\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId",
"value": "amet ut",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
}
]
},
"description": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n"
},
"response": [
{
"name": "The VLAN 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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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\": \"magna in Lorem\",\n \"compartmentId\": \"amet ut quis\",\n \"cidrBlock\": \"consequat non\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"sit consectetur Ut qui\",\n \"availabilityDomain\": \"ea sunt officia mollit\",\n \"definedTags\": {},\n \"displayName\": \"ullamco magna eu\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"ad amet exercitation\",\n \"ut irure magna\"\n ],\n \"routeTableId\": \"sunt occaecat exercitation mollit\",\n \"timeCreated\": \"1974-12-31T12:49:21.840Z\",\n \"vlanTag\": -19036463\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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"definedTags\": {},\n \"displayName\": \"laboris tempor\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"culpa in\",\n \"do mollit dolore\"\n ],\n \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans/:vlanId",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans",
":vlanId"
],
"variable": [
{
"key": "vlanId"
}
]
}
},
"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}"
}
]
}
