Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *compartmentId;
const char *id;
const char *lifecycleState;
const char *timeCreated;
const char *operatingSystem;
const char *operatingSystemVersion;
BOOL createImageAllowed;
const char *Value;
const char *IsMonitoringSupportedValue;
const char *baseImageId;
int billableSizeInGBs;
const char *displayName;
const char *launchMode;
const char *BootVolumeTypeValue;
const char *FirmwareValue;
const char *IsConsistentVolumeNamingEnabledValue;
const char *IsPvEncryptionInTransitEnabledValue;
const char *NetworkTypeValue;
const char *RemoteDataVolumeTypeValue;
int sizeInMBs;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_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.
// {
// "definedTags": {},
// "displayName": "elit reprehenderit consequat",
// "freeformTags": {},
// "operatingSystem": "in quis commodo",
// "operatingSystemVersion": "dolore nisi"
// }
json = CkJsonObject_Create();
CkJsonObject_UpdateNewObject(json,"definedTags");
CkJsonObject_UpdateString(json,"displayName","elit reprehenderit consequat");
CkJsonObject_UpdateNewObject(json,"freeformTags");
CkJsonObject_UpdateString(json,"operatingSystem","in quis commodo");
CkJsonObject_UpdateString(json,"operatingSystemVersion","dolore nisi");
CkHttp_SetRequestHeader(http,"opc-retry-token","aliqua enim i");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
CkHttp_SetRequestHeader(http,"x-content-sha256","{{content_sha256}}");
CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
CkHttp_SetRequestHeader(http,"Date","{{date}}");
CkHttp_SetRequestHeader(http,"if-match","officia sed");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
resp = CkHttp_PTextSb(http,"PUT","https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "compartmentId": "dolor commodo in",
// "id": "eu dolor Duis dolore irure",
// "lifecycleState": "AVAILABLE",
// "timeCreated": "1985-05-13T06:46:51.335Z",
// "operatingSystem": "deserunt cillum elit",
// "operatingSystemVersion": "sint et mollit do",
// "createImageAllowed": true,
// "agentFeatures": {
// "isManagementSupported": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isMonitoringSupported": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "baseImageId": "cillum exercitation voluptate non ullamco",
// "billableSizeInGBs": 16490567,
// "definedTags": {},
// "displayName": "qui laborum ad",
// "freeformTags": {},
// "launchMode": "PARAVIRTUALIZED",
// "launchOptions": {
// "bootVolumeType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "firmware": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isConsistentVolumeNamingEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isPvEncryptionInTransitEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "networkType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "remoteDataVolumeType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "sizeInMBs": 57090852
// }
// 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 = CkJsonObject_stringOf(jResp,"compartmentId");
id = CkJsonObject_stringOf(jResp,"id");
lifecycleState = CkJsonObject_stringOf(jResp,"lifecycleState");
timeCreated = CkJsonObject_stringOf(jResp,"timeCreated");
operatingSystem = CkJsonObject_stringOf(jResp,"operatingSystem");
operatingSystemVersion = CkJsonObject_stringOf(jResp,"operatingSystemVersion");
createImageAllowed = CkJsonObject_BoolOf(jResp,"createImageAllowed");
Value = CkJsonObject_stringOf(jResp,"agentFeatures.isManagementSupported.value");
IsMonitoringSupportedValue = CkJsonObject_stringOf(jResp,"agentFeatures.isMonitoringSupported.value");
baseImageId = CkJsonObject_stringOf(jResp,"baseImageId");
billableSizeInGBs = CkJsonObject_IntOf(jResp,"billableSizeInGBs");
displayName = CkJsonObject_stringOf(jResp,"displayName");
launchMode = CkJsonObject_stringOf(jResp,"launchMode");
BootVolumeTypeValue = CkJsonObject_stringOf(jResp,"launchOptions.bootVolumeType.value");
FirmwareValue = CkJsonObject_stringOf(jResp,"launchOptions.firmware.value");
IsConsistentVolumeNamingEnabledValue = CkJsonObject_stringOf(jResp,"launchOptions.isConsistentVolumeNamingEnabled.value");
IsPvEncryptionInTransitEnabledValue = CkJsonObject_stringOf(jResp,"launchOptions.isPvEncryptionInTransitEnabled.value");
NetworkTypeValue = CkJsonObject_stringOf(jResp,"launchOptions.networkType.value");
RemoteDataVolumeTypeValue = CkJsonObject_stringOf(jResp,"launchOptions.remoteDataVolumeType.value");
sizeInMBs = CkJsonObject_IntOf(jResp,"sizeInMBs");
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X PUT
-H "opc-retry-token: aliqua enim i"
-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": "elit reprehenderit consequat",
"freeformTags": {},
"operatingSystem": "in quis commodo",
"operatingSystemVersion": "dolore nisi"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId
Postman Collection Item JSON
{
"name": "UpdateImage",
"request": {
"method": "PUT",
"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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId",
"value": "officia sed",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
}
]
},
"description": "Updates the display name of the image. Avoid entering confidential information.\n"
},
"response": [
{
"name": "The image name was updated.",
"originalRequest": {
"method": "PUT",
"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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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\": \"dolor commodo in\",\n \"id\": \"eu dolor Duis dolore irure\",\n \"lifecycleState\": \"AVAILABLE\",\n \"timeCreated\": \"1985-05-13T06:46:51.335Z\",\n \"operatingSystem\": \"deserunt cillum elit\",\n \"operatingSystemVersion\": \"sint et mollit do\",\n \"createImageAllowed\": true,\n \"agentFeatures\": {\n \"isManagementSupported\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isMonitoringSupported\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"baseImageId\": \"cillum exercitation voluptate non ullamco\",\n \"billableSizeInGBs\": 16490567,\n \"definedTags\": {},\n \"displayName\": \"qui laborum ad\",\n \"freeformTags\": {},\n \"launchMode\": \"PARAVIRTUALIZED\",\n \"launchOptions\": {\n \"bootVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"firmware\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isConsistentVolumeNamingEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPvEncryptionInTransitEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"networkType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"remoteDataVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"sizeInMBs\": 57090852\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "PUT",
"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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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": "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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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": "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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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": "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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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": "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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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": "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"
},
{
"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\": \"elit reprehenderit consequat\",\n \"freeformTags\": {},\n \"operatingSystem\": \"in quis commodo\",\n \"operatingSystemVersion\": \"dolore nisi\"\n}"
},
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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}"
}
]
}
