Chilkat Online Tools

delphiDll / Core Services API / UpdateVolumeBackup

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
v_type: PWideChar;
displayName: PWideChar;
compartmentId: PWideChar;
timeCreated: PWideChar;
lifecycleState: PWideChar;
expirationTime: PWideChar;
kmsKeyId: PWideChar;
sizeInGBs: Integer;
sizeInMBs: Integer;
sourceType: PWideChar;
sourceVolumeBackupId: PWideChar;
timeRequestReceived: PWideChar;
uniqueSizeInGBs: Integer;
uniqueSizeInMbs: Integer;
volumeId: PWideChar;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// 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": {}
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateNewObject(json,'definedTags');
CkJsonObject_UpdateString(json,'displayName','cillum aute voluptate consectetur');
CkJsonObject_UpdateNewObject(json,'freeformTags');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'x-content-sha256','{{content_sha256}}');
CkHttp_SetRequestHeader(http,'Authorization','{{signature}}');
CkHttp_SetRequestHeader(http,'Date','{{date}}');
CkHttp_SetRequestHeader(http,'if-match','officia sed');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// 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

id := CkJsonObject__stringOf(jResp,'id');
v_type := CkJsonObject__stringOf(jResp,'type');
displayName := CkJsonObject__stringOf(jResp,'displayName');
compartmentId := CkJsonObject__stringOf(jResp,'compartmentId');
timeCreated := CkJsonObject__stringOf(jResp,'timeCreated');
lifecycleState := CkJsonObject__stringOf(jResp,'lifecycleState');
expirationTime := CkJsonObject__stringOf(jResp,'expirationTime');
kmsKeyId := CkJsonObject__stringOf(jResp,'kmsKeyId');
sizeInGBs := CkJsonObject_IntOf(jResp,'sizeInGBs');
sizeInMBs := CkJsonObject_IntOf(jResp,'sizeInMBs');
sourceType := CkJsonObject__stringOf(jResp,'sourceType');
sourceVolumeBackupId := CkJsonObject__stringOf(jResp,'sourceVolumeBackupId');
timeRequestReceived := CkJsonObject__stringOf(jResp,'timeRequestReceived');
uniqueSizeInGBs := CkJsonObject_IntOf(jResp,'uniqueSizeInGBs');
uniqueSizeInMbs := CkJsonObject_IntOf(jResp,'uniqueSizeInMbs');
volumeId := CkJsonObject__stringOf(jResp,'volumeId');

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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}"
    }
  ]
}