Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": "pariatur dolore in mollit",
; "freeformTags": {},
; "hostnameLabel": "reprehenderit esse ut culpa",
; "nsgIds": [
; "veniam Lorem ut ex do",
; "incididunt laboris"
; ],
; "skipSourceDestCheck": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","pariatur dolore in mollit")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkJsonObject::ckUpdateString(json,"hostnameLabel","reprehenderit esse ut culpa")
CkJsonObject::ckUpdateString(json,"nsgIds[0]","veniam Lorem ut ex do")
CkJsonObject::ckUpdateString(json,"nsgIds[1]","incididunt laboris")
CkJsonObject::ckUpdateBool(json,"skipSourceDestCheck",1)
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
CkHttp::ckSetRequestHeader(http,"if-match","officia sed")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
resp.i = CkHttpResponse::ckCreate()
If resp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckHttpSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/vnics/:vnicId",sbRequestBody,"utf-8","application/json",resp)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkHttpResponse::ckDispose(resp)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "availabilityDomain": "irure esse ut aute do",
; "compartmentId": "commodo sed",
; "id": "Excepteur",
; "lifecycleState": "TERMINATED",
; "timeCreated": "1956-01-11T19:38:23.750Z",
; "definedTags": {},
; "displayName": "amet id qui ullamco ",
; "freeformTags": {},
; "hostnameLabel": "culpa dolor Ut tempor quis",
; "isPrimary": true,
; "macAddress": "exercitation in",
; "nsgIds": [
; "ut anim",
; "in consectetur ut est"
; ],
; "privateIp": "laboris ullamco",
; "publicIp": "tempor cillum",
; "skipSourceDestCheck": true,
; "subnetId": "amet velit aliquip",
; "vlanId": "nisi ea sed"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
id.s = CkJsonObject::ckStringOf(jResp,"id")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
hostnameLabel.s = CkJsonObject::ckStringOf(jResp,"hostnameLabel")
isPrimary.i = CkJsonObject::ckBoolOf(jResp,"isPrimary")
macAddress.s = CkJsonObject::ckStringOf(jResp,"macAddress")
privateIp.s = CkJsonObject::ckStringOf(jResp,"privateIp")
publicIp.s = CkJsonObject::ckStringOf(jResp,"publicIp")
skipSourceDestCheck.i = CkJsonObject::ckBoolOf(jResp,"skipSourceDestCheck")
subnetId.s = CkJsonObject::ckStringOf(jResp,"subnetId")
vlanId.s = CkJsonObject::ckStringOf(jResp,"vlanId")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"nsgIds")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"nsgIds[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkHttpResponse::ckDispose(resp)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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": "pariatur dolore in mollit",
"freeformTags": {},
"hostnameLabel": "reprehenderit esse ut culpa",
"nsgIds": [
"veniam Lorem ut ex do",
"incididunt laboris"
],
"skipSourceDestCheck": true
}'
https://iaas.{{region}}.oraclecloud.com/20160918/vnics/:vnicId
Postman Collection Item JSON
{
"name": "UpdateVnic",
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
}
]
},
"description": "Updates the specified VNIC.\n"
},
"response": [
{
"name": "The VNIC 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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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 \"availabilityDomain\": \"irure esse ut aute do\",\n \"compartmentId\": \"commodo sed\",\n \"id\": \"Excepteur\",\n \"lifecycleState\": \"TERMINATED\",\n \"timeCreated\": \"1956-01-11T19:38:23.750Z\",\n \"definedTags\": {},\n \"displayName\": \"amet id qui ullamco \",\n \"freeformTags\": {},\n \"hostnameLabel\": \"culpa dolor Ut tempor quis\",\n \"isPrimary\": true,\n \"macAddress\": \"exercitation in\",\n \"nsgIds\": [\n \"ut anim\",\n \"in consectetur ut est\"\n ],\n \"privateIp\": \"laboris ullamco\",\n \"publicIp\": \"tempor cillum\",\n \"skipSourceDestCheck\": true,\n \"subnetId\": \"amet velit aliquip\",\n \"vlanId\": \"nisi ea sed\"\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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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\": \"pariatur dolore in mollit\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"reprehenderit esse ut culpa\",\n \"nsgIds\": [\n \"veniam Lorem ut ex do\",\n \"incididunt laboris\"\n ],\n \"skipSourceDestCheck\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/vnics/:vnicId",
"host": [
"{{baseUrl}}"
],
"path": [
"vnics",
":vnicId"
],
"variable": [
{
"key": "vnicId"
}
]
}
},
"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}"
}
]
}
