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.
-- {
-- "locationName": "sunt non",
-- "portSpeedShapeName": "consequat magna",
-- "compartmentId": "{{compartment_ocid}}",
-- "crossConnectGroupId": "amet aute",
-- "customerReferenceName": "veniam magna cillum aliquip",
-- "definedTags": {},
-- "displayName": "laborum velit commodo ad",
-- "farCrossConnectOrCrossConnectGroupId": "enim ex si",
-- "freeformTags": {},
-- "nearCrossConnectOrCrossConnectGroupId": "adipisicing dolore"
-- }
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, 'locationName', 'sunt non'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'portSpeedShapeName', 'consequat magna'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'compartmentId', '{{compartment_ocid}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'crossConnectGroupId', 'amet aute'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'customerReferenceName', 'veniam magna cillum aliquip'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'definedTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'laborum velit commodo ad'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'farCrossConnectOrCrossConnectGroupId', 'enim ex si'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'freeformTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'nearCrossConnectOrCrossConnectGroupId', 'adipisicing dolore'
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/crossConnects', '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": "eiusmod",
-- "crossConnectGroupId": "in in esse reprehenderit",
-- "customerReferenceName": "magna Excepteur aliqua pariatur est",
-- "definedTags": {},
-- "displayName": "adipisicing deserunt culpa nisi dolore",
-- "freeformTags": {},
-- "id": "amet cillum oc",
-- "lifecycleState": "TERMINATING",
-- "locationName": "id",
-- "portName": "velit veniam sunt",
-- "portSpeedShapeName": "culpa ullamco esse et",
-- "timeCreated": "1954-06-26T01:15:04.287Z"
-- }
-- 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 @crossConnectGroupId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @crossConnectGroupId OUT, 'crossConnectGroupId'
DECLARE @customerReferenceName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @customerReferenceName OUT, 'customerReferenceName'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
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 @locationName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @locationName OUT, 'locationName'
DECLARE @portName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @portName OUT, 'portName'
DECLARE @portSpeedShapeName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @portSpeedShapeName OUT, 'portSpeedShapeName'
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 '{
"locationName": "sunt non",
"portSpeedShapeName": "consequat magna",
"compartmentId": "{{compartment_ocid}}",
"crossConnectGroupId": "amet aute",
"customerReferenceName": "veniam magna cillum aliquip",
"definedTags": {},
"displayName": "laborum velit commodo ad",
"farCrossConnectOrCrossConnectGroupId": "enim ex si",
"freeformTags": {},
"nearCrossConnectOrCrossConnectGroupId": "adipisicing dolore"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/crossConnects
Postman Collection Item JSON
{
"name": "CreateCrossConnect",
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"{{compartment_ocid}}\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
},
"description": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect to reside. If you're\nnot sure which compartment to use, put the cross-connect in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n"
},
"response": [
{
"name": "The cross-connect 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"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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\": \"eiusmod\",\n \"crossConnectGroupId\": \"in in esse reprehenderit\",\n \"customerReferenceName\": \"magna Excepteur aliqua pariatur est\",\n \"definedTags\": {},\n \"displayName\": \"adipisicing deserunt culpa nisi dolore\",\n \"freeformTags\": {},\n \"id\": \"amet cillum oc\",\n \"lifecycleState\": \"TERMINATING\",\n \"locationName\": \"id\",\n \"portName\": \"velit veniam sunt\",\n \"portSpeedShapeName\": \"culpa ullamco esse et\",\n \"timeCreated\": \"1954-06-26T01:15:04.287Z\"\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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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": "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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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 \"locationName\": \"sunt non\",\n \"portSpeedShapeName\": \"consequat magna\",\n \"compartmentId\": \"pariatur est consectetur\",\n \"crossConnectGroupId\": \"amet aute\",\n \"customerReferenceName\": \"veniam magna cillum aliquip\",\n \"definedTags\": {},\n \"displayName\": \"laborum velit commodo ad\",\n \"farCrossConnectOrCrossConnectGroupId\": \"enim ex si\",\n \"freeformTags\": {},\n \"nearCrossConnectOrCrossConnectGroupId\": \"adipisicing dolore\"\n}"
},
"url": {
"raw": "{{baseUrl}}/crossConnects",
"host": [
"{{baseUrl}}"
],
"path": [
"crossConnects"
]
}
},
"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}"
}
]
}