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,"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/bootVolumes/:bootVolumeId",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)
; {
; "id": "officia reprehenderit",
; "availabilityDomain": "Duis nostrud do non deserunt",
; "sizeInMBs": -98569692,
; "compartmentId": "Excepteur Lorem",
; "timeCreated": "1956-06-30T22:30:00.790Z",
; "lifecycleState": "RESTORING",
; "autoTunedVpusPerGB": -7197285,
; "bootVolumeReplicas": [
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; ],
; "definedTags": {},
; "displayName": "irure Lorem ad",
; "freeformTags": {},
; "imageId": "non in sit",
; "isAutoTuneEnabled": true,
; "isHydrated": false,
; "kmsKeyId": "consequat incididunt labore eiusmod quis",
; "sizeInGBs": -5147606,
; "sourceDetails": {
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "volumeGroupId": "sed",
; "vpusPerGB": -31448022
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
value.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
sizeInMBs.i = CkJsonObject::ckIntOf(jResp,"sizeInMBs")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
autoTunedVpusPerGB.i = CkJsonObject::ckIntOf(jResp,"autoTunedVpusPerGB")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
imageId.s = CkJsonObject::ckStringOf(jResp,"imageId")
isAutoTuneEnabled.i = CkJsonObject::ckBoolOf(jResp,"isAutoTuneEnabled")
isHydrated.i = CkJsonObject::ckBoolOf(jResp,"isHydrated")
kmsKeyId.s = CkJsonObject::ckStringOf(jResp,"kmsKeyId")
sizeInGBs.i = CkJsonObject::ckIntOf(jResp,"sizeInGBs")
Value.s = CkJsonObject::ckStringOf(jResp,"sourceDetails.type.value")
volumeGroupId.s = CkJsonObject::ckStringOf(jResp,"volumeGroupId")
vpusPerGB.i = CkJsonObject::ckIntOf(jResp,"vpusPerGB")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"bootVolumeReplicas")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"bootVolumeReplicas[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumes/:bootVolumeId
Postman Collection Item JSON
{
"name": "GetBootVolume",
"request": {
"method": "GET",
"header": [
{
"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}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId",
"value": "officia sed",
"description": "(Required) The OCID of the boot volume."
}
]
},
"description": "Gets information for the specified boot volume."
},
"response": [
{
"name": "The boot volume's information has been retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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\": \"officia reprehenderit\",\n \"availabilityDomain\": \"Duis nostrud do non deserunt\",\n \"sizeInMBs\": -98569692,\n \"compartmentId\": \"Excepteur Lorem\",\n \"timeCreated\": \"1956-06-30T22:30:00.790Z\",\n \"lifecycleState\": \"RESTORING\",\n \"autoTunedVpusPerGB\": -7197285,\n \"bootVolumeReplicas\": [\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 \"definedTags\": {},\n \"displayName\": \"irure Lorem ad\",\n \"freeformTags\": {},\n \"imageId\": \"non in sit\",\n \"isAutoTuneEnabled\": true,\n \"isHydrated\": false,\n \"kmsKeyId\": \"consequat incididunt labore eiusmod quis\",\n \"sizeInGBs\": -5147606,\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"volumeGroupId\": \"sed\",\n \"vpusPerGB\": -31448022\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes",
":bootVolumeId"
],
"variable": [
{
"key": "bootVolumeId"
}
]
}
},
"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}"
}
]
}
