Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sV_type
String sDisplayName
String sCompartmentId
String sTimeCreated
String sLifecycleState
String sExpirationTime
String sKmsKeyId
Integer iSizeInGBs
Integer iSizeInMBs
String sSourceType
String sSourceVolumeBackupId
String sTimeRequestReceived
Integer iUniqueSizeInGBs
Integer iUniqueSizeInMbs
String sVolumeId
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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": "cillum aute voluptate consectetur",
// "freeformTags": {}
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateNewObject Of hoJson "definedTags" To iSuccess
Get ComUpdateString Of hoJson "displayName" "cillum aute voluptate consectetur" To iSuccess
Get ComUpdateNewObject Of hoJson "freeformTags" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "x-content-sha256" "{{content_sha256}}"
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Send ComSetRequestHeader To hoHttp "if-match" "officia sed"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "ea",
// "type": "FULL",
// "displayName": "amet elit occaecat laboris",
// "compartmentId": "eu et sint",
// "timeCreated": "2007-11-11T04:41:21.719Z",
// "lifecycleState": "CREATING",
// "definedTags": {},
// "expirationTime": "1998-05-31T02:51:40.598Z",
// "freeformTags": {},
// "kmsKeyId": "nostrud sint",
// "sizeInGBs": 11402,
// "sizeInMBs": 12081259,
// "sourceType": "MANUAL",
// "sourceVolumeBackupId": "in magna laboris consectetur",
// "timeRequestReceived": "1981-12-16T03:31:57.153Z",
// "uniqueSizeInGBs": 2257,
// "uniqueSizeInMbs": 13322289,
// "volumeId": "eu mollit consectetur Excepteur"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "type" To sV_type
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "expirationTime" To sExpirationTime
Get ComStringOf Of hoJResp "kmsKeyId" To sKmsKeyId
Get ComIntOf Of hoJResp "sizeInGBs" To iSizeInGBs
Get ComIntOf Of hoJResp "sizeInMBs" To iSizeInMBs
Get ComStringOf Of hoJResp "sourceType" To sSourceType
Get ComStringOf Of hoJResp "sourceVolumeBackupId" To sSourceVolumeBackupId
Get ComStringOf Of hoJResp "timeRequestReceived" To sTimeRequestReceived
Get ComIntOf Of hoJResp "uniqueSizeInGBs" To iUniqueSizeInGBs
Get ComIntOf Of hoJResp "uniqueSizeInMbs" To iUniqueSizeInMbs
Get ComStringOf Of hoJResp "volumeId" To sVolumeId
End_Procedure
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 '{
"definedTags": {},
"displayName": "cillum aute voluptate consectetur",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId
Postman Collection Item JSON
{
"name": "UpdateVolumeBackup",
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId",
"value": "officia sed",
"description": "(Required) The OCID of the volume backup."
}
]
},
"description": "Updates the display name for the specified volume backup.\nAvoid entering confidential information.\n"
},
"response": [
{
"name": "The volume backup 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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "etag",
"value": "officia sed",
"description": "For optimistic concurrency control. See `if-match`.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"ea\",\n \"type\": \"FULL\",\n \"displayName\": \"amet elit occaecat laboris\",\n \"compartmentId\": \"eu et sint\",\n \"timeCreated\": \"2007-11-11T04:41:21.719Z\",\n \"lifecycleState\": \"CREATING\",\n \"definedTags\": {},\n \"expirationTime\": \"1998-05-31T02:51:40.598Z\",\n \"freeformTags\": {},\n \"kmsKeyId\": \"nostrud sint\",\n \"sizeInGBs\": 11402,\n \"sizeInMBs\": 12081259,\n \"sourceType\": \"MANUAL\",\n \"sourceVolumeBackupId\": \"in magna laboris consectetur\",\n \"timeRequestReceived\": \"1981-12-16T03:31:57.153Z\",\n \"uniqueSizeInGBs\": 2257,\n \"uniqueSizeInMbs\": 13322289,\n \"volumeId\": \"eu mollit consectetur Excepteur\"\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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"cillum aute voluptate consectetur\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}"
}
]
}
