Chilkat Online Tools

Ruby / Core Services API / UpdateCrossConnect

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "customerReferenceName": "consequat sint ad occaecat dolor",
#   "definedTags": {},
#   "displayName": "ullamco qui Ut anim",
#   "freeformTags": {},
#   "isActive": true
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("customerReferenceName","consequat sint ad occaecat dolor")
json.UpdateNewObject("definedTags")
json.UpdateString("displayName","ullamco qui Ut anim")
json.UpdateNewObject("freeformTags")
json.UpdateBool("isActive",true)

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 = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/crossConnects/:crossConnectId",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "compartmentId": "eiusmod",
#   "crossConnectGroupId": "in in esse reprehenderit",
#   "customerReferenceName": "magna Excepteur aliqua pariatur est",
#   "definedTags": {},
#   "displayName": "adipisicing deserunt culpa nisi dolore",
#   "freeformTags": {},
#   "id": "amet cillum oc",
#   "lifecycleState": "TERMINATING",
#   "locationName": "id",
#   "portName": "velit veniam sunt",
#   "portSpeedShapeName": "culpa ullamco esse et",
#   "timeCreated": "1954-06-26T01:15:04.287Z"
# }

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

compartmentId = jResp.stringOf("compartmentId")
crossConnectGroupId = jResp.stringOf("crossConnectGroupId")
customerReferenceName = jResp.stringOf("customerReferenceName")
displayName = jResp.stringOf("displayName")
id = jResp.stringOf("id")
lifecycleState = jResp.stringOf("lifecycleState")
locationName = jResp.stringOf("locationName")
portName = jResp.stringOf("portName")
portSpeedShapeName = jResp.stringOf("portSpeedShapeName")
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 '{
    "customerReferenceName": "consequat sint ad occaecat dolor",
    "definedTags": {},
    "displayName": "ullamco qui Ut anim",
    "freeformTags": {},
    "isActive": true
}'
https://iaas.{{region}}.oraclecloud.com/20160918/crossConnects/:crossConnectId

Postman Collection Item JSON

{
  "name": "UpdateCrossConnect",
  "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "crossConnects",
        ":crossConnectId"
      ],
      "variable": [
        {
          "key": "crossConnectId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
        }
      ]
    },
    "description": "Updates the specified cross-connect."
  },
  "response": [
    {
      "name": "The cross-connect 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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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 \"compartmentId\": \"eiusmod\",\n \"crossConnectGroupId\": \"in in esse reprehenderit\",\n \"customerReferenceName\": \"magna Excepteur aliqua pariatur est\",\n \"definedTags\": {},\n \"displayName\": \"adipisicing deserunt culpa nisi dolore\",\n \"freeformTags\": {},\n \"id\": \"amet cillum oc\",\n \"lifecycleState\": \"TERMINATING\",\n \"locationName\": \"id\",\n \"portName\": \"velit veniam sunt\",\n \"portSpeedShapeName\": \"culpa ullamco esse et\",\n \"timeCreated\": \"1954-06-26T01:15:04.287Z\"\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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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    \"customerReferenceName\": \"consequat sint ad occaecat dolor\",\n    \"definedTags\": {},\n    \"displayName\": \"ullamco qui Ut anim\",\n    \"freeformTags\": {},\n    \"isActive\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnects/:crossConnectId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnects",
            ":crossConnectId"
          ],
          "variable": [
            {
              "key": "crossConnectId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}