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.
-- {
-- "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": {}
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'availabilityDomain', 'dolore ut'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'sourceDetails.type.value', '<Error: Too many levels of nesting to fake this schema>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'backupPolicyId', 'sunt irure aliqua enim'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'definedTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'veniam aute incididunt labore'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'freeformTags'
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/volumeGroups', '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": "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
DECLARE @strVal nvarchar(4000)
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @availabilityDomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @sizeInMBs int
EXEC sp_OAMethod @jResp, 'IntOf', @sizeInMBs OUT, 'sizeInMBs'
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @isHydrated int
EXEC sp_OAMethod @jResp, 'BoolOf', @isHydrated OUT, 'isHydrated'
DECLARE @sizeInGBs int
EXEC sp_OAMethod @jResp, 'IntOf', @sizeInGBs OUT, 'sizeInGBs'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'sourceDetails.type.value'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'volumeIds'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'volumeIds[i]'
SELECT @i = @i + 1
END
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 '{
"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}"
}
]
}
