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.
-- {
-- "serviceId": "in"
-- }
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, 'serviceId', 'in'
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}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'if-match', 'officia sed'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways/:serviceGatewayId/actions/detachService', '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 eu esse consectetur",
-- "id": "eu ad anim",
-- "lifecycleState": "TERMINATING",
-- "vcnId": "ea culpa et Duis deserunt",
-- "blockTraffic": false,
-- "services": [
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- },
-- {
-- "value": "<Error: Too many levels of nesting to fake this schema>"
-- }
-- ],
-- "definedTags": {},
-- "displayName": "Lorem Excepteur mini",
-- "freeformTags": {},
-- "routeTableId": "ex",
-- "timeCreated": "2015-12-17T16:51:12.199Z"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @value nvarchar(4000)
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 @vcnId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vcnId OUT, 'vcnId'
DECLARE @blockTraffic int
EXEC sp_OAMethod @jResp, 'BoolOf', @blockTraffic OUT, 'blockTraffic'
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 @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'services'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'services[i].value'
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 "if-match: officia sed"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"serviceId": "in"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways/:serviceGatewayId/actions/detachService
Postman Collection Item JSON
{
"name": "DetachService",
"request": {
"method": "POST",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
},
{
"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 \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId",
"value": "amet ut",
"description": "(Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
}
]
},
"description": "Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled\n`Service` objects for the specified gateway. You do not need to remove any route\nrules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider\nremoving the rules if your intent is to permanently disable use of the `Service` through this\nservice gateway.\n\n**Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call. `UpdateServiceGateway` also lets you block all traffic through the service\ngateway without having to remove each of the individual `Service` objects.\n"
},
"response": [
{
"name": "The service has been disabled for the service gateway.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"status": "OK",
"code": 200,
"_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 \"compartmentId\": \"Ut eu esse consectetur\",\n \"id\": \"eu ad anim\",\n \"lifecycleState\": \"TERMINATING\",\n \"vcnId\": \"ea culpa et Duis deserunt\",\n \"blockTraffic\": false,\n \"services\": [\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n ],\n \"definedTags\": {},\n \"displayName\": \"Lorem Excepteur mini\",\n \"freeformTags\": {},\n \"routeTableId\": \"ex\",\n \"timeCreated\": \"2015-12-17T16:51:12.199Z\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
"key": "if-match",
"value": "officia sed"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"serviceId\": \"in\"\n}"
},
"url": {
"raw": "{{baseUrl}}/serviceGateways/:serviceGatewayId/actions/detachService",
"host": [
"{{baseUrl}}"
],
"path": [
"serviceGateways",
":serviceGatewayId",
"actions",
"detachService"
],
"variable": [
{
"key": "serviceGatewayId"
}
]
}
},
"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}"
}
]
}
