Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": "dolore nostrud",
; "freeformTags": {},
; "hostnameLabel": "et dolor incididunt veniam",
; "ipAddress": "ut mollit a",
; "vlanId": "anim aute dolore",
; "vnicId": "elit adipisicing "
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","dolore nostrud")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
CkJsonObject::ckUpdateString(json,"hostnameLabel","et dolor incididunt veniam")
CkJsonObject::ckUpdateString(json,"ipAddress","ut mollit a")
CkJsonObject::ckUpdateString(json,"vlanId","anim aute dolore")
CkJsonObject::ckUpdateString(json,"vnicId","elit adipisicing ")
CkHttp::ckSetRequestHeader(http,"opc-retry-token","aliqua enim i")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
resp.i = CkHttp::ckPostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/privateIps","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
hostnameLabel.s = CkJsonObject::ckStringOf(jResp,"hostnameLabel")
id.s = CkJsonObject::ckStringOf(jResp,"id")
ipAddress.s = CkJsonObject::ckStringOf(jResp,"ipAddress")
isPrimary.i = CkJsonObject::ckBoolOf(jResp,"isPrimary")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
subnetId.s = CkJsonObject::ckStringOf(jResp,"subnetId")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
vlanId.s = CkJsonObject::ckStringOf(jResp,"vlanId")
vnicId.s = CkJsonObject::ckStringOf(jResp,"vnicId")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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 '{
"definedTags": {},
"displayName": "dolore nostrud",
"freeformTags": {},
"hostnameLabel": "et dolor incididunt veniam",
"ipAddress": "ut mollit a",
"vlanId": "anim aute dolore",
"vnicId": "elit adipisicing "
}'
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps
Postman Collection Item JSON
{
"name": "CreatePrivateIp",
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
},
"description": "Creates a secondary private IP for the specified VNIC.\nFor more information about secondary private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n"
},
"response": [
{
"name": "The private 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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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": "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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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 \"definedTags\": {},\n \"displayName\": \"dolore nostrud\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"et dolor incididunt veniam\",\n \"ipAddress\": \"ut mollit a\",\n \"vlanId\": \"anim aute dolore\",\n \"vnicId\": \"elit adipisicing \"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps"
]
}
},
"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}"
}
]
}
