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.
-- {
-- "definedTags": {},
-- "displayName": "ullamco quis sed nostru",
-- "freeformTags": {},
-- "hostnameLabel": "t",
-- "vnicId": "magna labor"
-- }
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, 'UpdateNewObject', @success OUT, 'definedTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'displayName', 'ullamco quis sed nostru'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'freeformTags'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'hostnameLabel', 't'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'vnicId', 'magna labor'
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 @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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
EXEC @hr = sp_OADestroy @sbRequestBody
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 @sbRequestBody
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)
-- {
-- "availabilityDomain": "Excepteur",
-- "compartmentId": "dolore est sed",
-- "definedTags": {},
-- "displayName": "amet dolor qui fugiat",
-- "freeformTags": {},
-- "hostnameLabel": "pariatur Lorem in",
-- "id": "qui Ut",
-- "ipAddress": "proident irure non enim",
-- "isPrimary": true,
-- "lifecycleState": "TERMINATING",
-- "subnetId": "velit tempor officia incididunt ullamco",
-- "timeCreated": "2011-12-31T21:46:36.823Z",
-- "vlanId": "ut ullamco reprehenderit",
-- "vnicId": "magna"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @availabilityDomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @hostnameLabel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @hostnameLabel OUT, 'hostnameLabel'
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 @isPrimary int
EXEC sp_OAMethod @jResp, 'BoolOf', @isPrimary OUT, 'isPrimary'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @subnetId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @subnetId OUT, 'subnetId'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @vlanId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vlanId OUT, 'vlanId'
DECLARE @vnicId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @vnicId OUT, 'vnicId'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "if-match: officia sed"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"definedTags": {},
"displayName": "ullamco quis sed nostru",
"freeformTags": {},
"hostnameLabel": "t",
"vnicId": "magna labor"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId
Postman Collection Item JSON
{
"name": "UpdatePrivateIp",
"request": {
"method": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId",
"value": "amet ut",
"description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
}
]
},
"description": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n"
},
"response": [
{
"name": "The private IP was updated.",
"originalRequest": {
"method": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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 \"availabilityDomain\": \"Excepteur\",\n \"compartmentId\": \"dolore est sed\",\n \"definedTags\": {},\n \"displayName\": \"amet dolor qui fugiat\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"pariatur Lorem in\",\n \"id\": \"qui Ut\",\n \"ipAddress\": \"proident irure non enim\",\n \"isPrimary\": true,\n \"lifecycleState\": \"TERMINATING\",\n \"subnetId\": \"velit tempor officia incididunt ullamco\",\n \"timeCreated\": \"2011-12-31T21:46:36.823Z\",\n \"vlanId\": \"ut ullamco reprehenderit\",\n \"vnicId\": \"magna\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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": "Precondition Failed",
"originalRequest": {
"method": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"status": "Precondition Failed",
"code": 412,
"_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": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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": "PUT",
"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 \"definedTags\": {},\n \"displayName\": \"ullamco quis sed nostru\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"t\",\n \"vnicId\": \"magna labor\"\n}"
},
"url": {
"raw": "{{baseUrl}}/privateIps/:privateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"privateIps",
":privateIpId"
],
"variable": [
{
"key": "privateIpId"
}
]
}
},
"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}"
}
]
}
