Chilkat Online Tools

autoit / Core Services API / UpdateCrossConnectGroup

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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": "id Excepteur",
;   "definedTags": {},
;   "displayName": "culpa mollit reprehenderit",
;   "freeformTags": {}
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("customerReferenceName","id Excepteur")
$oJson.UpdateNewObject("definedTags")
$oJson.UpdateString("displayName","culpa mollit reprehenderit")
$oJson.UpdateNewObject("freeformTags")

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

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/crossConnectGroups/:crossConnectGroupId",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

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

; {
;   "compartmentId": "mollit mini",
;   "customerReferenceName": "officia deserunt veniam amet",
;   "definedTags": {},
;   "displayName": "voluptate non en",
;   "freeformTags": {},
;   "id": "quis c",
;   "lifecycleState": "INACTIVE",
;   "timeCreated": "1949-09-29T22:08:43.421Z"
; }

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

Local $sCompartmentId = $oJResp.StringOf("compartmentId")
Local $sCustomerReferenceName = $oJResp.StringOf("customerReferenceName")
Local $sDisplayName = $oJResp.StringOf("displayName")
Local $sId = $oJResp.StringOf("id")
Local $sLifecycleState = $oJResp.StringOf("lifecycleState")
Local $sTimeCreated = $oJResp.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": "id Excepteur",
    "definedTags": {},
    "displayName": "culpa mollit reprehenderit",
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/crossConnectGroups/:crossConnectGroupId

Postman Collection Item JSON

{
  "name": "UpdateCrossConnectGroup",
  "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "crossConnectGroups",
        ":crossConnectGroupId"
      ],
      "variable": [
        {
          "key": "crossConnectGroupId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
        }
      ]
    },
    "description": "Updates the specified cross-connect group's display name.\nAvoid entering confidential information.\n"
  },
  "response": [
    {
      "name": "The cross-connect group 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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"mollit mini\",\n \"customerReferenceName\": \"officia deserunt veniam amet\",\n \"definedTags\": {},\n \"displayName\": \"voluptate non en\",\n \"freeformTags\": {},\n \"id\": \"quis c\",\n \"lifecycleState\": \"INACTIVE\",\n \"timeCreated\": \"1949-09-29T22:08:43.421Z\"\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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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\": \"id Excepteur\",\n    \"definedTags\": {},\n    \"displayName\": \"culpa mollit reprehenderit\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/crossConnectGroups/:crossConnectGroupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "crossConnectGroups",
            ":crossConnectGroupId"
          ],
          "variable": [
            {
              "key": "crossConnectGroupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}