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.
; {
; "instanceId": "consequat laboris",
; "volumeId": "nulla dolor consectetur Duis",
; "type": "in occaecat velit in",
; "device": "Duis",
; "displayName": "dolore enim cillum",
; "isReadOnly": false,
; "isShareable": true
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"instanceId","consequat laboris")
CkJsonObject::ckUpdateString(json,"volumeId","nulla dolor consectetur Duis")
CkJsonObject::ckUpdateString(json,"type","in occaecat velit in")
CkJsonObject::ckUpdateString(json,"device","Duis")
CkJsonObject::ckUpdateString(json,"displayName","dolore enim cillum")
CkJsonObject::ckUpdateBool(json,"isReadOnly",0)
CkJsonObject::ckUpdateBool(json,"isShareable",1)
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/volumeAttachments/","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": "ipsum minim",
; "attachmentType": "non",
; "instanceId": "esse ea sint",
; "volumeId": "minim occaecat in est anim",
; "lifecycleState": "ATTACHING",
; "compartmentId": "eu ex sunt",
; "availabilityDomain": "magna proident",
; "timeCreated": "1954-08-02T00:08:02.631Z",
; "device": "consequat Lorem",
; "displayName": "cupidatat do dolore cillum",
; "isMultipath": false,
; "isPvEncryptionInTransitEnabled": true,
; "isReadOnly": true,
; "isShareable": true,
; "iscsiLoginState": "UNKNOWN"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s = CkJsonObject::ckStringOf(jResp,"id")
attachmentType.s = CkJsonObject::ckStringOf(jResp,"attachmentType")
instanceId.s = CkJsonObject::ckStringOf(jResp,"instanceId")
volumeId.s = CkJsonObject::ckStringOf(jResp,"volumeId")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
device.s = CkJsonObject::ckStringOf(jResp,"device")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
isMultipath.i = CkJsonObject::ckBoolOf(jResp,"isMultipath")
isPvEncryptionInTransitEnabled.i = CkJsonObject::ckBoolOf(jResp,"isPvEncryptionInTransitEnabled")
isReadOnly.i = CkJsonObject::ckBoolOf(jResp,"isReadOnly")
isShareable.i = CkJsonObject::ckBoolOf(jResp,"isShareable")
iscsiLoginState.s = CkJsonObject::ckStringOf(jResp,"iscsiLoginState")
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 '{
"instanceId": "consequat laboris",
"volumeId": "nulla dolor consectetur Duis",
"type": "in occaecat velit in",
"device": "Duis",
"displayName": "dolore enim cillum",
"isReadOnly": false,
"isShareable": true
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/
Postman Collection Item JSON
{
"name": "AttachVolume",
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
},
"description": "Attaches the specified storage volume to the specified instance.\n"
},
"response": [
{
"name": "The volume is being attached.",
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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\": \"ipsum minim\",\n \"attachmentType\": \"non\",\n \"instanceId\": \"esse ea sint\",\n \"volumeId\": \"minim occaecat in est anim\",\n \"lifecycleState\": \"ATTACHING\",\n \"compartmentId\": \"eu ex sunt\",\n \"availabilityDomain\": \"magna proident\",\n \"timeCreated\": \"1954-08-02T00:08:02.631Z\",\n \"device\": \"consequat Lorem\",\n \"displayName\": \"cupidatat do dolore cillum\",\n \"isMultipath\": false,\n \"isPvEncryptionInTransitEnabled\": true,\n \"isReadOnly\": true,\n \"isShareable\": true,\n \"iscsiLoginState\": \"UNKNOWN\"\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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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 \"instanceId\": \"consequat laboris\",\n \"volumeId\": \"nulla dolor consectetur Duis\",\n \"type\": \"in occaecat velit in\",\n \"device\": \"Duis\",\n \"displayName\": \"dolore enim cillum\",\n \"isReadOnly\": false,\n \"isShareable\": true\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeAttachments/",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeAttachments",
""
]
}
},
"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}"
}
]
}
