Chilkat Online Tools

DataFlex / Core Services API / UpdatePrivateIp

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 sAvailabilityDomain
    String sCompartmentId
    String sDisplayName
    String sHostnameLabel
    String sId
    String sIpAddress
    Boolean iIsPrimary
    String sLifecycleState
    String sSubnetId
    String sTimeCreated
    String sVlanId
    String sVnicId
    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": "ullamco quis sed nostru",
    //   "freeformTags": {},
    //   "hostnameLabel": "t",
    //   "vnicId": "magna labor"
    // }

    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" "ullamco quis sed nostru" To iSuccess
    Get ComUpdateNewObject Of hoJson "freeformTags" To iSuccess
    Get ComUpdateString Of hoJson "hostnameLabel" "t" To iSuccess
    Get ComUpdateString Of hoJson "vnicId" "magna labor" 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/privateIps/:privateIpId" 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)

    // {
    //   "availabilityDomain": "Excepteur",
    //   "compartmentId": "dolore est sed",
    //   "definedTags": {},
    //   "displayName": "amet dolor qui fugiat",
    //   "freeformTags": {},
    //   "hostnameLabel": "pariatur Lorem in",
    //   "id": "qui Ut",
    //   "ipAddress": "proident irure non enim",
    //   "isPrimary": true,
    //   "lifecycleState": "TERMINATING",
    //   "subnetId": "velit tempor officia incididunt ullamco",
    //   "timeCreated": "2011-12-31T21:46:36.823Z",
    //   "vlanId": "ut ullamco reprehenderit",
    //   "vnicId": "magna"
    // }

    // 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 "availabilityDomain" To sAvailabilityDomain
    Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
    Get ComStringOf Of hoJResp "displayName" To sDisplayName
    Get ComStringOf Of hoJResp "hostnameLabel" To sHostnameLabel
    Get ComStringOf Of hoJResp "id" To sId
    Get ComStringOf Of hoJResp "ipAddress" To sIpAddress
    Get ComBoolOf Of hoJResp "isPrimary" To iIsPrimary
    Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
    Get ComStringOf Of hoJResp "subnetId" To sSubnetId
    Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
    Get ComStringOf Of hoJResp "vlanId" To sVlanId
    Get ComStringOf Of hoJResp "vnicId" To sVnicId


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": "ullamco quis sed nostru",
    "freeformTags": {},
    "hostnameLabel": "t",
    "vnicId": "magna labor"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId

Postman Collection Item JSON

{
  "name": "UpdatePrivateIp",
  "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/privateIps/:privateIpId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "privateIps",
        ":privateIpId"
      ],
      "variable": [
        {
          "key": "privateIpId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
        }
      ]
    },
    "description": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n  - Move a secondary private IP to a different VNIC in the same subnet.\n  - Change the display name for a secondary private IP.\n  - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n"
  },
  "response": [
    {
      "name": "The private 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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"Excepteur\",\n \"compartmentId\": \"dolore est sed\",\n \"definedTags\": {},\n \"displayName\": \"amet dolor qui fugiat\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"pariatur Lorem in\",\n \"id\": \"qui Ut\",\n \"ipAddress\": \"proident irure non enim\",\n \"isPrimary\": true,\n \"lifecycleState\": \"TERMINATING\",\n \"subnetId\": \"velit tempor officia incididunt ullamco\",\n \"timeCreated\": \"2011-12-31T21:46:36.823Z\",\n \"vlanId\": \"ut ullamco reprehenderit\",\n \"vnicId\": \"magna\"\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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}