Chilkat Online Tools

delphiAx / Core Services API / UpdateInternetGateway

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
compartmentId: WideString;
lifecycleState: WideString;
vcnId: WideString;
displayName: WideString;
isEnabled: Integer;
timeCreated: WideString;

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

http := TChilkatHttp.Create(Self);

// 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": "mollit Duis ad consequat",
//   "freeformTags": {},
//   "isEnabled": false
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateNewObject('definedTags');
json.UpdateString('displayName','mollit Duis ad consequat');
json.UpdateNewObject('freeformTags');
json.UpdateBool('isEnabled',0);

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

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PUT','https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

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

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

    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "quis laborum eu",
//   "compartmentId": "sed",
//   "lifecycleState": "AVAILABLE",
//   "vcnId": "fugiat nostrud",
//   "definedTags": {},
//   "displayName": "Ut reprehend",
//   "freeformTags": {},
//   "isEnabled": true,
//   "timeCreated": "1994-01-17T22:51:32.949Z"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

id := jResp.StringOf('id');
compartmentId := jResp.StringOf('compartmentId');
lifecycleState := jResp.StringOf('lifecycleState');
vcnId := jResp.StringOf('vcnId');
displayName := jResp.StringOf('displayName');
isEnabled := jResp.BoolOf('isEnabled');
timeCreated := jResp.StringOf('timeCreated');

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": "mollit Duis ad consequat",
    "freeformTags": {},
    "isEnabled": false
}'
https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId

Postman Collection Item JSON

{
  "name": "UpdateInternetGateway",
  "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/internetGateways/:igId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "internetGateways",
        ":igId"
      ],
      "variable": [
        {
          "key": "igId",
          "value": "ocid1.internetgateway.oc1....",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
        }
      ]
    },
    "description": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n"
  },
  "response": [
    {
      "name": "The internet gateway 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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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\": \"quis laborum eu\",\n \"compartmentId\": \"sed\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"fugiat nostrud\",\n \"definedTags\": {},\n \"displayName\": \"Ut reprehend\",\n \"freeformTags\": {},\n \"isEnabled\": true,\n \"timeCreated\": \"1994-01-17T22:51:32.949Z\"\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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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": "Conflict",
      "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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\": \"mollit Duis ad consequat\",\n    \"freeformTags\": {},\n    \"isEnabled\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}