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.
; {
; "availabilityDomain": "dolore ut",
; "compartmentId": "{{compartment_ocid}}",
; "sourceDetails": {
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; },
; "backupPolicyId": "sunt irure aliqua enim",
; "definedTags": {},
; "displayName": "veniam aute incididunt labore",
; "freeformTags": {}
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"availabilityDomain","dolore ut")
CkJsonObject::ckUpdateString(json,"compartmentId","{{compartment_ocid}}")
CkJsonObject::ckUpdateString(json,"sourceDetails.type.value","<Error: Too many levels of nesting to fake this schema>")
CkJsonObject::ckUpdateString(json,"backupPolicyId","sunt irure aliqua enim")
CkJsonObject::ckUpdateNewObject(json,"definedTags")
CkJsonObject::ckUpdateString(json,"displayName","veniam aute incididunt labore")
CkJsonObject::ckUpdateNewObject(json,"freeformTags")
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/volumeGroups","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)
; {
; "id": "voluptate veniam culpa",
; "volumeIds": [
; "et proident minim",
; "id aliquip"
; ],
; "availabilityDomain": "Excepteur",
; "displayName": "esse",
; "sizeInMBs": -79372556,
; "compartmentId": "exercitation",
; "timeCreated": "1975-12-22T14:06:08.177Z",
; "lifecycleState": "AVAILABLE",
; "definedTags": {},
; "freeformTags": {},
; "isHydrated": false,
; "sizeInGBs": 2892595,
; "sourceDetails": {
; "type": {
; "value": "<Error: Too many levels of nesting to fake this schema>"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
strVal.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
sizeInMBs.i = CkJsonObject::ckIntOf(jResp,"sizeInMBs")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
isHydrated.i = CkJsonObject::ckBoolOf(jResp,"isHydrated")
sizeInGBs.i = CkJsonObject::ckIntOf(jResp,"sizeInGBs")
Value.s = CkJsonObject::ckStringOf(jResp,"sourceDetails.type.value")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"volumeIds")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"volumeIds[i]")
i = i + 1
Wend
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 '{
"availabilityDomain": "dolore ut",
"compartmentId": "{{compartment_ocid}}",
"sourceDetails": {
"type": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"backupPolicyId": "sunt irure aliqua enim",
"definedTags": {},
"displayName": "veniam aute incididunt labore",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroups
Postman Collection Item JSON
{
"name": "CreateVolumeGroup",
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
},
"description": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
},
"response": [
{
"name": "The volume group is being 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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"id\": \"voluptate veniam culpa\",\n \"volumeIds\": [\n \"et proident minim\",\n \"id aliquip\"\n ],\n \"availabilityDomain\": \"Excepteur\",\n \"displayName\": \"esse\",\n \"sizeInMBs\": -79372556,\n \"compartmentId\": \"exercitation\",\n \"timeCreated\": \"1975-12-22T14:06:08.177Z\",\n \"lifecycleState\": \"AVAILABLE\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isHydrated\": false,\n \"sizeInGBs\": 2892595,\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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 \"availabilityDomain\": \"dolore ut\",\n \"compartmentId\": \"nostrud amet qui ad in\",\n \"sourceDetails\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"backupPolicyId\": \"sunt irure aliqua enim\",\n \"definedTags\": {},\n \"displayName\": \"veniam aute incididunt labore\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroups",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroups"
]
}
},
"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}"
}
]
}
