Chilkat Online Tools

Foxpro / Core Services API / UpdateInternetGateway

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcCompartmentId
LOCAL lcLifecycleState
LOCAL lcVcnId
LOCAL lcDisplayName
LOCAL lnIsEnabled
LOCAL lcTimeCreated

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* 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
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateNewObject("definedTags")
loJson.UpdateString("displayName","mollit Duis ad consequat")
loJson.UpdateNewObject("freeformTags")
loJson.UpdateBool("isEnabled",0)

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

loSbRequestBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcId = loJResp.StringOf("id")
lcCompartmentId = loJResp.StringOf("compartmentId")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcVcnId = loJResp.StringOf("vcnId")
lcDisplayName = loJResp.StringOf("displayName")
lnIsEnabled = loJResp.BoolOf("isEnabled")
lcTimeCreated = loJResp.StringOf("timeCreated")

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp

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