Chilkat Online Tools

unicodeC / Core Services API / UpdateCpe

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *compartmentId;
    const wchar_t *id;
    const wchar_t *ipAddress;
    const wchar_t *cpeDeviceShapeId;
    const wchar_t *displayName;
    const wchar_t *timeCreated;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttpW_Create();

    // 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": {}
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"cpeDeviceShapeId",L"Ut");
    CkJsonObjectW_UpdateNewObject(json,L"definedTags");
    CkJsonObjectW_UpdateString(json,L"displayName",L"do aute");
    CkJsonObjectW_UpdateNewObject(json,L"freeformTags");

    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
    CkHttpW_SetRequestHeader(http,L"x-content-sha256",L"{{content_sha256}}");
    CkHttpW_SetRequestHeader(http,L"Authorization",L"{{signature}}");
    CkHttpW_SetRequestHeader(http,L"Date",L"{{date}}");
    CkHttpW_SetRequestHeader(http,L"if-match",L"officia sed");

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://iaas.{{region}}.oraclecloud.com/20160918/cpes/:cpeId",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    id = CkJsonObjectW_stringOf(jResp,L"id");
    ipAddress = CkJsonObjectW_stringOf(jResp,L"ipAddress");
    cpeDeviceShapeId = CkJsonObjectW_stringOf(jResp,L"cpeDeviceShapeId");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

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}"
    }
  ]
}