Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *value;
const char *Value;
const char *VendorValue;
const char *cpeDeviceShapeId;
const char *template;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_SetRequestHeader(http,"opc-request-id","8wF");
CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
CkHttp_SetRequestHeader(http,"Date","{{date}}");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/cpeDeviceShapes/:cpeDeviceShapeId",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "cpeDeviceInfo": {
// "platformSoftwareVersion": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vendor": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "cpeDeviceShapeId": "tempor ea incididunt",
// "parameters": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "template": "eu nulla"
// }
// 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.
Value = CkJsonObject_stringOf(jResp,"cpeDeviceInfo.platformSoftwareVersion.value");
VendorValue = CkJsonObject_stringOf(jResp,"cpeDeviceInfo.vendor.value");
cpeDeviceShapeId = CkJsonObject_stringOf(jResp,"cpeDeviceShapeId");
template = CkJsonObject_stringOf(jResp,"template");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"parameters");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
value = CkJsonObject_stringOf(jResp,"parameters[i].value");
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "opc-request-id: 8wF"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/cpeDeviceShapes/:cpeDeviceShapeId
Postman Collection Item JSON
{
"name": "GetCpeDeviceShape",
"request": {
"method": "GET",
"header": [
{
"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": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId",
"value": "amet ut",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape."
}
]
},
"description": "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n"
},
"response": [
{
"name": "The parameters is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId"
}
]
}
},
"status": "OK",
"code": 200,
"_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 \"cpeDeviceInfo\": {\n \"platformSoftwareVersion\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vendor\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"cpeDeviceShapeId\": \"tempor ea incididunt\",\n \"parameters\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"template\": \"eu nulla\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId"
}
]
}
},
"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": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId"
}
]
}
},
"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": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId"
}
]
}
},
"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": "GET",
"header": [
{
"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"
}
],
"url": {
"raw": "{{baseUrl}}/cpeDeviceShapes/:cpeDeviceShapeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpeDeviceShapes",
":cpeDeviceShapeId"
],
"variable": [
{
"key": "cpeDeviceShapeId"
}
]
}
},
"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}"
}
]
}
