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.
-- {
-- "predictionDefinition": "<PREDICTION_DEFINITION_ID>",
-- "type": "RawData",
-- "columnNames": [
-- "Quantity",
-- "Category",
-- "Sub_Category",
-- "Sales",
-- "Profit_per_Order"
-- ],
-- "rows": [
-- [
-- "2",
-- "Furniture",
-- "Chairs",
-- "300",
-- "10"
-- ]
-- ]
-- }
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, 'predictionDefinition', '<PREDICTION_DEFINITION_ID>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'RawData'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'columnNames[0]', 'Quantity'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'columnNames[1]', 'Category'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'columnNames[2]', 'Sub_Category'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'columnNames[3]', 'Sales'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'columnNames[4]', 'Profit_per_Order'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'rows[0][0]', '2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'rows[0][1]', 'Furniture'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'rows[0][2]', 'Chairs'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'rows[0][3]', '300'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'rows[0][4]', '10'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict', '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)
-- {
-- "predictionDefinition": "1OR5Y0000010ws8",
-- "predictions": [
-- {
-- "model": {
-- "id": "1Ot5Y0000010wzNSAQ"
-- },
-- "prediction": {
-- "middleValues": [
-- ],
-- "total": 88.52494255547592
-- },
-- "prescriptions": [
-- ],
-- "status": "Success"
-- }
-- ],
-- "settings": {
-- "maxMiddleValues": 0,
-- "maxPrescriptions": 0,
-- "prescriptionImpactPercentage": 0
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Id nvarchar(4000)
DECLARE @Total nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @predictionDefinition nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @predictionDefinition OUT, 'predictionDefinition'
DECLARE @MaxMiddleValues int
EXEC sp_OAMethod @jResp, 'IntOf', @MaxMiddleValues OUT, 'settings.maxMiddleValues'
DECLARE @MaxPrescriptions int
EXEC sp_OAMethod @jResp, 'IntOf', @MaxPrescriptions OUT, 'settings.maxPrescriptions'
DECLARE @PrescriptionImpactPercentage int
EXEC sp_OAMethod @jResp, 'IntOf', @PrescriptionImpactPercentage OUT, 'settings.prescriptionImpactPercentage'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'predictions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'predictions[i].model.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Total OUT, 'predictions[i].prediction.total'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'predictions[i].status'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'predictions[i].prediction.middleValues'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'predictions[i].prescriptions'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
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 "Authorization: Bearer <access_token>"
-d '{
"predictionDefinition": "<PREDICTION_DEFINITION_ID>",
"type": "RawData",
"columnNames": [
"Quantity",
"Category",
"Sub_Category",
"Sales",
"Profit_per_Order"
],
"rows": [
[
"2",
"Furniture",
"Chairs",
"300",
"10"
]
]
}'
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict
Postman Collection Item JSON
{
"name": "Predict",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"predictionDefinition\": \"<PREDICTION_DEFINITION_ID>\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predict"
]
},
"description": "Get available prediction definitions."
},
"response": [
{
"name": "Predict",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"predictionDefinition\": \"1OR5Y0000010ws8WAA\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predict"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 04 Mar 2021 13:53:39 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536002; includeSubDomains"
},
{
"key": "Expect-CT",
"value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm\""
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"predictionDefinition\": \"1OR5Y0000010ws8\",\n \"predictions\": [\n {\n \"model\": {\n \"id\": \"1Ot5Y0000010wzNSAQ\"\n },\n \"prediction\": {\n \"middleValues\": [],\n \"total\": 88.52494255547592\n },\n \"prescriptions\": [],\n \"status\": \"Success\"\n }\n ],\n \"settings\": {\n \"maxMiddleValues\": 0,\n \"maxPrescriptions\": 0,\n \"prescriptionImpactPercentage\": 0\n }\n}"
}
]
}
