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
-- 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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "compartmentId": "dolor commodo in",
-- "id": "eu dolor Duis dolore irure",
-- "lifecycleState": "AVAILABLE",
-- "timeCreated": "1985-05-13T06:46:51.335Z",
-- "operatingSystem": "deserunt cillum elit",
-- "operatingSystemVersion": "sint et mollit do",
-- "createImageAllowed": true,
-- "agentFeatures": {
-- "isManagementSupported": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "isMonitoringSupported": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "baseImageId": "cillum exercitation voluptate non ullamco",
-- "billableSizeInGBs": 16490567,
-- "definedTags": {},
-- "displayName": "qui laborum ad",
-- "freeformTags": {},
-- "launchMode": "PARAVIRTUALIZED",
-- "launchOptions": {
-- "bootVolumeType": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "firmware": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "isConsistentVolumeNamingEnabled": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "isPvEncryptionInTransitEnabled": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "networkType": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- "remoteDataVolumeType": {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- },
-- "sizeInMBs": 57090852
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @operatingSystem nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @operatingSystem OUT, 'operatingSystem'
DECLARE @operatingSystemVersion nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @operatingSystemVersion OUT, 'operatingSystemVersion'
DECLARE @createImageAllowed int
EXEC sp_OAMethod @jResp, 'BoolOf', @createImageAllowed OUT, 'createImageAllowed'
DECLARE @Value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'agentFeatures.isManagementSupported.value'
DECLARE @IsMonitoringSupportedValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @IsMonitoringSupportedValue OUT, 'agentFeatures.isMonitoringSupported.value'
DECLARE @baseImageId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @baseImageId OUT, 'baseImageId'
DECLARE @billableSizeInGBs int
EXEC sp_OAMethod @jResp, 'IntOf', @billableSizeInGBs OUT, 'billableSizeInGBs'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @launchMode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @launchMode OUT, 'launchMode'
DECLARE @BootVolumeTypeValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @BootVolumeTypeValue OUT, 'launchOptions.bootVolumeType.value'
DECLARE @FirmwareValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @FirmwareValue OUT, 'launchOptions.firmware.value'
DECLARE @IsConsistentVolumeNamingEnabledValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @IsConsistentVolumeNamingEnabledValue OUT, 'launchOptions.isConsistentVolumeNamingEnabled.value'
DECLARE @IsPvEncryptionInTransitEnabledValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @IsPvEncryptionInTransitEnabledValue OUT, 'launchOptions.isPvEncryptionInTransitEnabled.value'
DECLARE @NetworkTypeValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @NetworkTypeValue OUT, 'launchOptions.networkType.value'
DECLARE @RemoteDataVolumeTypeValue nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @RemoteDataVolumeTypeValue OUT, 'launchOptions.remoteDataVolumeType.value'
DECLARE @sizeInMBs int
EXEC sp_OAMethod @jResp, 'IntOf', @sizeInMBs OUT, 'sizeInMBs'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/images/:imageId
Postman Collection Item JSON
{
"name": "GetImage",
"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}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId",
"value": "officia sed",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
}
]
},
"description": "Gets the specified image."
},
"response": [
{
"name": "The image was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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 \"compartmentId\": \"dolor commodo in\",\n \"id\": \"eu dolor Duis dolore irure\",\n \"lifecycleState\": \"AVAILABLE\",\n \"timeCreated\": \"1985-05-13T06:46:51.335Z\",\n \"operatingSystem\": \"deserunt cillum elit\",\n \"operatingSystemVersion\": \"sint et mollit do\",\n \"createImageAllowed\": true,\n \"agentFeatures\": {\n \"isManagementSupported\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isMonitoringSupported\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"baseImageId\": \"cillum exercitation voluptate non ullamco\",\n \"billableSizeInGBs\": 16490567,\n \"definedTags\": {},\n \"displayName\": \"qui laborum ad\",\n \"freeformTags\": {},\n \"launchMode\": \"PARAVIRTUALIZED\",\n \"launchOptions\": {\n \"bootVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"firmware\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isConsistentVolumeNamingEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPvEncryptionInTransitEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"networkType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"remoteDataVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"sizeInMBs\": 57090852\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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}}/images/:imageId",
"host": [
"{{baseUrl}}"
],
"path": [
"images",
":imageId"
],
"variable": [
{
"key": "imageId"
}
]
}
},
"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}"
}
]
}
