Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"opc-request-id","8wF")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/cpeDeviceShapes/:cpeDeviceShapeId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
value.s
Value.s = CkJsonObject::ckStringOf(jResp,"cpeDeviceInfo.platformSoftwareVersion.value")
VendorValue.s = CkJsonObject::ckStringOf(jResp,"cpeDeviceInfo.vendor.value")
cpeDeviceShapeId.s = CkJsonObject::ckStringOf(jResp,"cpeDeviceShapeId")
template.s = CkJsonObject::ckStringOf(jResp,"template")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"parameters")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"parameters[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
