Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'instanceId', 'consequat laboris'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'volumeId', 'nulla dolor consectetur Duis'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'in occaecat velit in'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'device', 'Duis'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'dolore enim cillum'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'isReadOnly', 0
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'isShareable', 1
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'opc-retry-token', 'aliqua enim i'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-content-sha256', '{{content_sha256}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @attachmentType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @attachmentType OUT, 'attachmentType'
DECLARE @instanceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @instanceId OUT, 'instanceId'
DECLARE @volumeId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @volumeId OUT, 'volumeId'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @availabilityDomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @device nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @device OUT, 'device'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @isMultipath int
EXEC sp_OAMethod @jResp, 'BoolOf', @isMultipath OUT, 'isMultipath'
DECLARE @isPvEncryptionInTransitEnabled int
EXEC sp_OAMethod @jResp, 'BoolOf', @isPvEncryptionInTransitEnabled OUT, 'isPvEncryptionInTransitEnabled'
DECLARE @isReadOnly int
EXEC sp_OAMethod @jResp, 'BoolOf', @isReadOnly OUT, 'isReadOnly'
DECLARE @isShareable int
EXEC sp_OAMethod @jResp, 'BoolOf', @isShareable OUT, 'isShareable'
DECLARE @iscsiLoginState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @iscsiLoginState OUT, 'iscsiLoginState'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
