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": "es",
-- "compartmentId": "{{compartment_ocid}}",
-- "cidrBlock": "esse est",
-- "vcnId": "ea aute",
-- "definedTags": {},
-- "displayName": "esse",
-- "freeformTags": {},
-- "nsgIds": [
-- "elit",
-- "nisi consequat ea dolore"
-- ],
-- "routeTableId": "sint laboris sed",
-- "vlanTag": 2006
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'availabilityDomain', 'es'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'cidrBlock', 'esse est'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'vcnId', 'ea aute'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'definedTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'esse'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'freeformTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'nsgIds[0]', 'elit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'nsgIds[1]', 'nisi consequat ea dolore'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'routeTableId', 'sint laboris sed'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'vlanTag', 2006
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'opc-retry-token', 'aliqua enim i'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'opc-request-id', '8wF'
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/vlans', '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": "magna in Lorem",
-- "compartmentId": "amet ut quis",
-- "cidrBlock": "consequat non",
-- "lifecycleState": "AVAILABLE",
-- "vcnId": "sit consectetur Ut qui",
-- "availabilityDomain": "ea sunt officia mollit",
-- "definedTags": {},
-- "displayName": "ullamco magna eu",
-- "freeformTags": {},
-- "nsgIds": [
-- "ad amet exercitation",
-- "ut irure magna"
-- ],
-- "routeTableId": "sunt occaecat exercitation mollit",
-- "timeCreated": "1974-12-31T12:49:21.840Z",
-- "vlanTag": -19036463
-- }
-- 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 @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @cidrBlock nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @cidrBlock OUT, 'cidrBlock'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @vcnId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vcnId OUT, 'vcnId'
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 @routeTableId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @routeTableId OUT, 'routeTableId'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @vlanTag int
EXEC sp_OAMethod @jResp, 'IntOf', @vlanTag OUT, 'vlanTag'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'nsgIds'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'nsgIds[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 "opc-request-id: 8wF"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"availabilityDomain": "es",
"compartmentId": "{{compartment_ocid}}",
"cidrBlock": "esse est",
"vcnId": "ea aute",
"definedTags": {},
"displayName": "esse",
"freeformTags": {},
"nsgIds": [
"elit",
"nisi consequat ea dolore"
],
"routeTableId": "sint laboris sed",
"vlanTag": 2006
}'
https://iaas.{{region}}.oraclecloud.com/20160918/vlans
Postman Collection Item JSON
{
"name": "CreateVlan",
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
},
{
"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\": \"es\",\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
},
"description": "Creates a VLAN in the specified VCN and the specified compartment.\n"
},
"response": [
{
"name": "The VLAN was 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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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\": \"magna in Lorem\",\n \"compartmentId\": \"amet ut quis\",\n \"cidrBlock\": \"consequat non\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"sit consectetur Ut qui\",\n \"availabilityDomain\": \"ea sunt officia mollit\",\n \"definedTags\": {},\n \"displayName\": \"ullamco magna eu\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"ad amet exercitation\",\n \"ut irure magna\"\n ],\n \"routeTableId\": \"sunt occaecat exercitation mollit\",\n \"timeCreated\": \"1974-12-31T12:49:21.840Z\",\n \"vlanTag\": -19036463\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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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"
},
{
"description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
"key": "opc-request-id",
"value": "8wF"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"availabilityDomain\": \"es\",\n \"compartmentId\": \"reprehenderit eu cillum \",\n \"cidrBlock\": \"esse est\",\n \"vcnId\": \"ea aute\",\n \"definedTags\": {},\n \"displayName\": \"esse\",\n \"freeformTags\": {},\n \"nsgIds\": [\n \"elit\",\n \"nisi consequat ea dolore\"\n ],\n \"routeTableId\": \"sint laboris sed\",\n \"vlanTag\": 2006\n}"
},
"url": {
"raw": "{{baseUrl}}/vlans",
"host": [
"{{baseUrl}}"
],
"path": [
"vlans"
]
}
},
"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}"
}
]
}
