Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCompartmentId
LOCAL lcId
LOCAL lcIpAddress
LOCAL lcCpeDeviceShapeId
LOCAL lcDisplayName
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.
* {
* "cpeDeviceShapeId": "Ut",
* "definedTags": {},
* "displayName": "do aute",
* "freeformTags": {}
* }
loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("cpeDeviceShapeId","Ut")
loJson.UpdateNewObject("definedTags")
loJson.UpdateString("displayName","do aute")
loJson.UpdateNewObject("freeformTags")
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/cpes/:cpeId",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)
* {
* "compartmentId": "ut commodo enim aute consectetur",
* "id": "incididunt anim",
* "ipAddress": "dolore consectetur",
* "cpeDeviceShapeId": "eiusmod laborum proi",
* "definedTags": {},
* "displayName": "tempor sint et pariatur",
* "freeformTags": {},
* "timeCreated": "1948-01-11T13:26:43.224Z"
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCompartmentId = loJResp.StringOf("compartmentId")
lcId = loJResp.StringOf("id")
lcIpAddress = loJResp.StringOf("ipAddress")
lcCpeDeviceShapeId = loJResp.StringOf("cpeDeviceShapeId")
lcDisplayName = loJResp.StringOf("displayName")
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 '{
"cpeDeviceShapeId": "Ut",
"definedTags": {},
"displayName": "do aute",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/cpes/:cpeId
Postman Collection Item JSON
{
"name": "UpdateCpe",
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
}
]
},
"description": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n"
},
"response": [
{
"name": "The CPE 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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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\": \"ut commodo enim aute consectetur\",\n \"id\": \"incididunt anim\",\n \"ipAddress\": \"dolore consectetur\",\n \"cpeDeviceShapeId\": \"eiusmod laborum proi\",\n \"definedTags\": {},\n \"displayName\": \"tempor sint et pariatur\",\n \"freeformTags\": {},\n \"timeCreated\": \"1948-01-11T13:26:43.224Z\"\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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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 \"cpeDeviceShapeId\": \"Ut\",\n \"definedTags\": {},\n \"displayName\": \"do aute\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes/:cpeId",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes",
":cpeId"
],
"variable": [
{
"key": "cpeId"
}
]
}
},
"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}"
}
]
}
