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
-- 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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "compartmentId": "{{compartment_ocid}}",
-- "ipAddress": "Duis commodo",
-- "cpeDeviceShapeId": "in cupidatat magna aute fugiat",
-- "definedTags": {},
-- "displayName": "dolor ut in velit sunt",
-- "freeformTags": {}
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ipAddress', 'Duis commodo'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'cpeDeviceShapeId', 'in cupidatat magna aute fugiat'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'definedTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'dolor ut in velit sunt'
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/cpes', '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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
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 @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)
-- {
-- "compartmentId": "ut commodo enim aute consectetur",
-- "id": "incididunt anim",
-- "ipAddress": "dolore consectetur",
-- "cpeDeviceShapeId": "eiusmod laborum proi",
-- "definedTags": {},
-- "displayName": "tempor sint et pariatur",
-- "freeformTags": {},
-- "timeCreated": "1948-01-11T13:26:43.224Z"
-- }
-- 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 @ipAddress nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @ipAddress OUT, 'ipAddress'
DECLARE @cpeDeviceShapeId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @cpeDeviceShapeId OUT, 'cpeDeviceShapeId'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
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 '{
"compartmentId": "{{compartment_ocid}}",
"ipAddress": "Duis commodo",
"cpeDeviceShapeId": "in cupidatat magna aute fugiat",
"definedTags": {},
"displayName": "dolor ut in velit sunt",
"freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/cpes
Postman Collection Item JSON
{
"name": "CreateCpe",
"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 \"compartmentId\": \"{{compartment_ocid}}\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
},
"description": "Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For\nmore information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec\nconnection or other Networking Service components. If you're not sure which compartment to\nuse, put the CPE in the same compartment as the DRG. For more information about\ncompartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must provide the public IP address of your on-premises router. See\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n\nYou may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n"
},
"response": [
{
"name": "The CPE has been 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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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\": \"ut commodo enim aute consectetur\",\n \"id\": \"incididunt anim\",\n \"ipAddress\": \"dolore consectetur\",\n \"cpeDeviceShapeId\": \"eiusmod laborum proi\",\n \"definedTags\": {},\n \"displayName\": \"tempor sint et pariatur\",\n \"freeformTags\": {},\n \"timeCreated\": \"1948-01-11T13:26:43.224Z\"\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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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 \"compartmentId\": \"nostrud in\",\n \"ipAddress\": \"Duis commodo\",\n \"cpeDeviceShapeId\": \"in cupidatat magna aute fugiat\",\n \"definedTags\": {},\n \"displayName\": \"dolor ut in velit sunt\",\n \"freeformTags\": {}\n}"
},
"url": {
"raw": "{{baseUrl}}/cpes",
"host": [
"{{baseUrl}}"
],
"path": [
"cpes"
]
}
},
"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}"
}
]
}
