Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/subnets/:subnetId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "vcnId": "enim non eu cillum",
; "id": "eu incididunt tempor",
; "compartmentId": "deserunt eu et v",
; "cidrBlock": "minim",
; "routeTableId": "veniam dolor voluptate m",
; "virtualRouterIp": "dolore dolor ven",
; "virtualRouterMac": "pariatur",
; "lifecycleState": "AVAILABLE",
; "availabilityDomain": "Lorem pariatur do",
; "definedTags": {},
; "dhcpOptionsId": "aute",
; "displayName": "Duis ad eu sunt",
; "dnsLabel": "eiusmod",
; "freeformTags": {},
; "ipv6CidrBlock": "adipisicing reprehende",
; "ipv6PublicCidrBlock": "sed Lorem",
; "ipv6VirtualRouterIp": "in ex cupidatat",
; "prohibitPublicIpOnVnic": false,
; "securityListIds": [
; "dolore in enim",
; "anim Lorem"
; ],
; "subnetDomainName": "labore cupidatat commodo",
; "timeCreated": "1995-01-31T14:27:19.328Z"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
vcnId.s = CkJsonObject::ckStringOf(jResp,"vcnId")
id.s = CkJsonObject::ckStringOf(jResp,"id")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
cidrBlock.s = CkJsonObject::ckStringOf(jResp,"cidrBlock")
routeTableId.s = CkJsonObject::ckStringOf(jResp,"routeTableId")
virtualRouterIp.s = CkJsonObject::ckStringOf(jResp,"virtualRouterIp")
virtualRouterMac.s = CkJsonObject::ckStringOf(jResp,"virtualRouterMac")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
dhcpOptionsId.s = CkJsonObject::ckStringOf(jResp,"dhcpOptionsId")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
dnsLabel.s = CkJsonObject::ckStringOf(jResp,"dnsLabel")
ipv6CidrBlock.s = CkJsonObject::ckStringOf(jResp,"ipv6CidrBlock")
ipv6PublicCidrBlock.s = CkJsonObject::ckStringOf(jResp,"ipv6PublicCidrBlock")
ipv6VirtualRouterIp.s = CkJsonObject::ckStringOf(jResp,"ipv6VirtualRouterIp")
prohibitPublicIpOnVnic.i = CkJsonObject::ckBoolOf(jResp,"prohibitPublicIpOnVnic")
subnetDomainName.s = CkJsonObject::ckStringOf(jResp,"subnetDomainName")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"securityListIds")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"securityListIds[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/subnets/:subnetId
Postman Collection Item JSON
{
"name": "GetSubnet",
"request": {
"method": "GET",
"header": [
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
}
]
},
"description": "Gets the specified subnet's information."
},
"response": [
{
"name": "The subnet was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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 \"vcnId\": \"enim non eu cillum\",\n \"id\": \"eu incididunt tempor\",\n \"compartmentId\": \"deserunt eu et v\",\n \"cidrBlock\": \"minim\",\n \"routeTableId\": \"veniam dolor voluptate m\",\n \"virtualRouterIp\": \"dolore dolor ven\",\n \"virtualRouterMac\": \"pariatur\",\n \"lifecycleState\": \"AVAILABLE\",\n \"availabilityDomain\": \"Lorem pariatur do\",\n \"definedTags\": {},\n \"dhcpOptionsId\": \"aute\",\n \"displayName\": \"Duis ad eu sunt\",\n \"dnsLabel\": \"eiusmod\",\n \"freeformTags\": {},\n \"ipv6CidrBlock\": \"adipisicing reprehende\",\n \"ipv6PublicCidrBlock\": \"sed Lorem\",\n \"ipv6VirtualRouterIp\": \"in ex cupidatat\",\n \"prohibitPublicIpOnVnic\": false,\n \"securityListIds\": [\n \"dolore in enim\",\n \"anim Lorem\"\n ],\n \"subnetDomainName\": \"labore cupidatat commodo\",\n \"timeCreated\": \"1995-01-31T14:27:19.328Z\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/subnets/:subnetId",
"host": [
"{{baseUrl}}"
],
"path": [
"subnets",
":subnetId"
],
"variable": [
{
"key": "subnetId"
}
]
}
},
"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}"
}
]
}
