Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAssignedEntityId
String sAssignedEntityType
String sAvailabilityDomain
String sCompartmentId
String sDisplayName
String sId
String sIpAddress
String sLifecycleState
String sLifetime
String sPrivateIpId
String sPublicIpPoolId
String sScope
String sTimeCreated
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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": "est exercitation proident voluptate",
// "freeformTags": {},
// "privateIpId": "proident magna sunt elit"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateNewObject Of hoJson "definedTags" To iSuccess
Get ComUpdateString Of hoJson "displayName" "est exercitation proident voluptate" To iSuccess
Get ComUpdateNewObject Of hoJson "freeformTags" To iSuccess
Get ComUpdateString Of hoJson "privateIpId" "proident magna sunt elit" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "x-content-sha256" "{{content_sha256}}"
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Send ComSetRequestHeader To hoHttp "if-match" "officia sed"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/:publicIpId" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "assignedEntityId": "eu reprehenderit aliquip nulla",
// "assignedEntityType": "NAT_GATEWAY",
// "availabilityDomain": "irure commodo",
// "compartmentId": "est dolor proident",
// "definedTags": {},
// "displayName": "ipsum quis dolore",
// "freeformTags": {},
// "id": "sint commodo dolor culpa",
// "ipAddress": "dolore quis esse aliqua",
// "lifecycleState": "UNASSIGNED",
// "lifetime": "EPHEMERAL",
// "privateIpId": "non in consectetur laborum nostrud",
// "publicIpPoolId": "quis aliquip anim",
// "scope": "REGION",
// "timeCreated": "1986-03-06T20:25:38.760Z"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "assignedEntityId" To sAssignedEntityId
Get ComStringOf Of hoJResp "assignedEntityType" To sAssignedEntityType
Get ComStringOf Of hoJResp "availabilityDomain" To sAvailabilityDomain
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "ipAddress" To sIpAddress
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "lifetime" To sLifetime
Get ComStringOf Of hoJResp "privateIpId" To sPrivateIpId
Get ComStringOf Of hoJResp "publicIpPoolId" To sPublicIpPoolId
Get ComStringOf Of hoJResp "scope" To sScope
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
End_Procedure
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": "est exercitation proident voluptate",
"freeformTags": {},
"privateIpId": "proident magna sunt elit"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/:publicIpId
Postman Collection Item JSON
{
"name": "UpdatePublicIp",
"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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
}
]
},
"description": "Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to:\n\n* Assign a reserved public IP in your pool to a private IP.\n* Move a reserved public IP to a different private IP.\n* Unassign a reserved public IP from a private IP (which returns it to your pool\nof reserved public IPs).\n* Change the display name or tags for a public IP.\n\nAssigning, moving, and unassigning a reserved public IP are asynchronous\noperations. Poll the public IP's `lifecycleState` to determine if the operation\nsucceeded.\n\n**Note:** When moving a reserved public IP, the target private IP\nmust not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it\ndoes, an error is returned. Also, the initial unassignment from the original\nprivate IP always succeeds, but the assignment to the target private IP is asynchronous and\ncould fail silently (for example, if the target private IP is deleted or has a different public IP\nassigned to it in the interim). If that occurs, the public IP remains unassigned and its\n`lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP).\nYou must poll the public IP's `lifecycleState` to determine if the move succeeded.\n\nRegarding ephemeral public IPs:\n\n* If you want to assign an ephemeral public IP to a primary private IP, use\n[CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp).\n* You can't move an ephemeral public IP to a different private IP.\n* If you want to unassign an ephemeral public IP from its private IP, use\n[DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which\nunassigns and deletes the ephemeral public IP.\n\n**Note:** If a public IP is assigned to a secondary private\nIP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary\nprivate IP to another VNIC, the public IP moves with it.\n\n**Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/)\na VNIC or instance can have. If you try to move a reserved public IP\nto a VNIC or instance that has already reached its public IP limit, an error is\nreturned. For information about the public IP limits, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n"
},
"response": [
{
"name": "The public IP 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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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 \"assignedEntityId\": \"eu reprehenderit aliquip nulla\",\n \"assignedEntityType\": \"NAT_GATEWAY\",\n \"availabilityDomain\": \"irure commodo\",\n \"compartmentId\": \"est dolor proident\",\n \"definedTags\": {},\n \"displayName\": \"ipsum quis dolore\",\n \"freeformTags\": {},\n \"id\": \"sint commodo dolor culpa\",\n \"ipAddress\": \"dolore quis esse aliqua\",\n \"lifecycleState\": \"UNASSIGNED\",\n \"lifetime\": \"EPHEMERAL\",\n \"privateIpId\": \"non in consectetur laborum nostrud\",\n \"publicIpPoolId\": \"quis aliquip anim\",\n \"scope\": \"REGION\",\n \"timeCreated\": \"1986-03-06T20:25:38.760Z\"\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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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": "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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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\": \"est exercitation proident voluptate\",\n \"freeformTags\": {},\n \"privateIpId\": \"proident magna sunt elit\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/:publicIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
":publicIpId"
],
"variable": [
{
"key": "publicIpId"
}
]
}
},
"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}"
}
]
}