Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "blockVolumeReplicas": [
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; ],
; "definedTags": {},
; "displayName": "sunt non",
; "freeformTags": {},
; "isAutoTuneEnabled": true,
; "sizeInGBs": -35753331,
; "vpusPerGB": -34400178
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"blockVolumeReplicas[0].value","<Error: Too many levels of nesting to fake this schema>")
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","sunt non")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkJsonObject::ckUpdateBool(json,"isAutoTuneEnabled",1)
CkJsonObject::ckUpdateInt(json,"sizeInGBs",-35753331)
CkJsonObject::ckUpdateInt(json,"vpusPerGB",-34400178)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
CkHttp::ckSetRequestHeader(http,"if-match","officia sed")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttp::ckPTextSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId",sbRequestBody,"utf-8","application/json",0,0)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "id": "dolore magna fugiat",
; "availabilityDomain": "ut",
; "displayName": "ut velit commodo",
; "sizeInMBs": -55113189,
; "compartmentId": "et ullamco consequat u",
; "timeCreated": "1988-12-07T08:21:37.359Z",
; "lifecycleState": "PROVISIONING",
; "autoTunedVpusPerGB": -84866272,
; "blockVolumeReplicas": [
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; },
; {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; ],
; "definedTags": {},
; "freeformTags": {},
; "isAutoTuneEnabled": false,
; "isHydrated": true,
; "kmsKeyId": "ullamco",
; "sizeInGBs": -13490866,
; "sourceDetails": {
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "volumeGroupId": "proident eu velit",
; "vpusPerGB": -99437639
; }
; 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")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
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")
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,"blockVolumeReplicas")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"blockVolumeReplicas[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X PUT
-H "if-match: officia sed"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"blockVolumeReplicas": [
{
"value": "<Error: Too many levels of nesting to fake this schema>"
}
],
"definedTags": {},
"displayName": "sunt non",
"freeformTags": {},
"isAutoTuneEnabled": true,
"sizeInGBs": -35753331,
"vpusPerGB": -34400178
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId
Postman Collection Item JSON
{
"name": "UpdateVolume",
"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"
},
{
"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 \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId",
"value": "officia sed",
"description": "(Required) The OCID of the volume."
}
]
},
"description": "Updates the specified volume's display name.\nAvoid entering confidential information.\n"
},
"response": [
{
"name": "The volume 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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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\": \"dolore magna fugiat\",\n \"availabilityDomain\": \"ut\",\n \"displayName\": \"ut velit commodo\",\n \"sizeInMBs\": -55113189,\n \"compartmentId\": \"et ullamco consequat u\",\n \"timeCreated\": \"1988-12-07T08:21:37.359Z\",\n \"lifecycleState\": \"PROVISIONING\",\n \"autoTunedVpusPerGB\": -84866272,\n \"blockVolumeReplicas\": [\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 \"freeformTags\": {},\n \"isAutoTuneEnabled\": false,\n \"isHydrated\": true,\n \"kmsKeyId\": \"ullamco\",\n \"sizeInGBs\": -13490866,\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"volumeGroupId\": \"proident eu velit\",\n \"vpusPerGB\": -99437639\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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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": "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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"blockVolumeReplicas\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"sunt non\",\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": true,\n \"sizeInGBs\": -35753331,\n \"vpusPerGB\": -34400178\n}"
},
"url": {
"raw": "{{baseUrl}}/volumes/:volumeId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumes",
":volumeId"
],
"variable": [
{
"key": "volumeId"
}
]
}
},
"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}"
}
]
}
