Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
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.
// {
// "compartmentId": "{{compartment_ocid}}",
// "lifetime": "RESERVED",
// "definedTags": {},
// "displayName": "Excepteur cupidatat culpa et esse",
// "freeformTags": {},
// "privateIpId": "sunt nostrud Ut ex officia",
// "publicIpPoolId": "veniam proident aliquip Duis"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "compartmentId" "{{compartment_ocid}}" To iSuccess
Get ComUpdateString Of hoJson "lifetime" "RESERVED" To iSuccess
Get ComUpdateNewObject Of hoJson "definedTags" To iSuccess
Get ComUpdateString Of hoJson "displayName" "Excepteur cupidatat culpa et esse" To iSuccess
Get ComUpdateNewObject Of hoJson "freeformTags" To iSuccess
Get ComUpdateString Of hoJson "privateIpId" "sunt nostrud Ut ex officia" To iSuccess
Get ComUpdateString Of hoJson "publicIpPoolId" "veniam proident aliquip Duis" To iSuccess
Send ComSetRequestHeader To hoHttp "opc-retry-token" "aliqua enim i"
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}}"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/publicIps" "application/json" vJson 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 POST
-H "opc-retry-token: aliqua enim i"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"compartmentId": "{{compartment_ocid}}",
"lifetime": "RESERVED",
"definedTags": {},
"displayName": "Excepteur cupidatat culpa et esse",
"freeformTags": {},
"privateIpId": "sunt nostrud Ut ex officia",
"publicIpPoolId": "veniam proident aliquip Duis"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps
Postman Collection Item JSON
{
"name": "CreatePublicIp",
"request": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
},
{
"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 \"compartmentId\": \"{{compartment_ocid}}\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
},
"description": "Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or\nreserved public IP. For information about limits on how many you can create, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\n* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId`\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is\ncreated in the same availability domain as the private IP. An ephemeral public IP must always be\nassigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary\nprivate IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle\nautomatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.\n\n* **For a reserved public IP:** You may also optionally assign the public IP to a private\nIP by specifying `privateIpId`. Or you can later assign the public IP with\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n\n**Note:** When assigning a public IP to a private IP, the private IP must not already have\na public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned.\n\nAlso, for reserved public IPs, the optional assignment part of this operation is\nasynchronous. Poll the public IP's `lifecycleState` to determine if the assignment\nsucceeded.\n"
},
"response": [
{
"name": "The public IP was created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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": "POST",
"header": [
{
"description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
"key": "opc-retry-token",
"value": "aliqua enim i"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"compartmentId\": \"qui anim ex\",\n \"lifetime\": \"RESERVED\",\n \"definedTags\": {},\n \"displayName\": \"Excepteur cupidatat culpa et esse\",\n \"freeformTags\": {},\n \"privateIpId\": \"sunt nostrud Ut ex officia\",\n \"publicIpPoolId\": \"veniam proident aliquip Duis\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps"
]
}
},
"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}"
}
]
}
