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
-- 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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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 @http, 'QuickGetSb', @success OUT, 'https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "models": [
-- {
-- "createdBy": {
-- "id": "0055Y00000DWwAIQA1",
-- "name": "Philippe Ozil",
-- "profilePhotoUrl": "https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T"
-- },
-- "createdDate": "2021-03-04T13:37:03.000Z",
-- "fieldMappingList": [
-- {
-- "modelField": {
-- "label": "Category",
-- "name": "Category",
-- "type": "Text"
-- }
-- },
-- {
-- "modelField": {
-- "label": "Sales",
-- "name": "Sales",
-- "type": "Number"
-- }
-- },
-- {
-- "modelField": {
-- "label": "Profit per Order",
-- "name": "Profit_per_Order",
-- "type": "Number"
-- }
-- },
-- {
-- "modelField": {
-- "label": "Sub-Category",
-- "name": "Sub_Category",
-- "type": "Text"
-- }
-- },
-- {
-- "modelField": {
-- "label": "Quantity",
-- "name": "Quantity",
-- "type": "Number"
-- }
-- }
-- ],
-- "filters": [
-- ],
-- "historyUrl": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories",
-- "id": "1Ot5Y0000010wzNSAQ",
-- "isRefreshEnabled": false,
-- "label": "superstore-orders",
-- "lastModifiedBy": {
-- "id": "0055Y00000DWwAIQA1",
-- "name": "Philippe Ozil",
-- "profilePhotoUrl": "https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T"
-- },
-- "lastModifiedDate": "2021-03-04T13:37:03.000Z",
-- "model": {
-- "id": "1OT5Y0000010zlzWAA"
-- },
-- "modelType": "Regression",
-- "name": "superstore_orders",
-- "predictionDefinitionUrl": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA",
-- "prescribableFields": [
-- {
-- "customDefinitions": [
-- ],
-- "field": {
-- "label": "Quantity",
-- "name": "Quantity",
-- "type": "Number"
-- }
-- }
-- ],
-- "sortOrder": 0,
-- "status": "Enabled",
-- "url": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ"
-- }
-- ],
-- "totalSize": 1,
-- "url": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models"
-- }
-- 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 @Name nvarchar(4000)
DECLARE @ProfilePhotoUrl nvarchar(4000)
DECLARE @createdDate nvarchar(4000)
DECLARE @historyUrl nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @isRefreshEnabled int
DECLARE @label nvarchar(4000)
DECLARE @lastModifiedById nvarchar(4000)
DECLARE @lastModifiedByName nvarchar(4000)
DECLARE @lastModifiedByProfilePhotoUrl nvarchar(4000)
DECLARE @lastModifiedDate nvarchar(4000)
DECLARE @modelId nvarchar(4000)
DECLARE @modelType nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @predictionDefinitionUrl nvarchar(4000)
DECLARE @sortOrder int
DECLARE @status nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @Label nvarchar(4000)
DECLARE @modelFieldName nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @fieldLabel nvarchar(4000)
DECLARE @fieldName nvarchar(4000)
DECLARE @fieldType nvarchar(4000)
DECLARE @k int
DECLARE @count_k int
DECLARE @totalSize int
EXEC sp_OAMethod @jResp, 'IntOf', @totalSize OUT, 'totalSize'
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'models'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'models[i].createdBy.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'models[i].createdBy.name'
EXEC sp_OAMethod @jResp, 'StringOf', @ProfilePhotoUrl OUT, 'models[i].createdBy.profilePhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @createdDate OUT, 'models[i].createdDate'
EXEC sp_OAMethod @jResp, 'StringOf', @historyUrl OUT, 'models[i].historyUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'models[i].id'
EXEC sp_OAMethod @jResp, 'BoolOf', @isRefreshEnabled OUT, 'models[i].isRefreshEnabled'
EXEC sp_OAMethod @jResp, 'StringOf', @label OUT, 'models[i].label'
EXEC sp_OAMethod @jResp, 'StringOf', @lastModifiedById OUT, 'models[i].lastModifiedBy.id'
EXEC sp_OAMethod @jResp, 'StringOf', @lastModifiedByName OUT, 'models[i].lastModifiedBy.name'
EXEC sp_OAMethod @jResp, 'StringOf', @lastModifiedByProfilePhotoUrl OUT, 'models[i].lastModifiedBy.profilePhotoUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @lastModifiedDate OUT, 'models[i].lastModifiedDate'
EXEC sp_OAMethod @jResp, 'StringOf', @modelId OUT, 'models[i].model.id'
EXEC sp_OAMethod @jResp, 'StringOf', @modelType OUT, 'models[i].modelType'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'models[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @predictionDefinitionUrl OUT, 'models[i].predictionDefinitionUrl'
EXEC sp_OAMethod @jResp, 'IntOf', @sortOrder OUT, 'models[i].sortOrder'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'models[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'models[i].url'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'models[i].fieldMappingList'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @Label OUT, 'models[i].fieldMappingList[j].modelField.label'
EXEC sp_OAMethod @jResp, 'StringOf', @modelFieldName OUT, 'models[i].fieldMappingList[j].modelField.name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'models[i].fieldMappingList[j].modelField.type'
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'models[i].filters'
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, 'models[i].prescribableFields'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @fieldLabel OUT, 'models[i].prescribableFields[j].field.label'
EXEC sp_OAMethod @jResp, 'StringOf', @fieldName OUT, 'models[i].prescribableFields[j].field.name'
EXEC sp_OAMethod @jResp, 'StringOf', @fieldType OUT, 'models[i].prescribableFields[j].field.type'
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'models[i].prescribableFields[j].customDefinitions'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models
Postman Collection Item JSON
{
"name": "Prediction models",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predictionDefinitions",
":PREDICTION_DEFINITION_ID",
"models"
],
"variable": [
{
"key": "PREDICTION_DEFINITION_ID",
"value": ""
}
]
},
"description": "Get available prediction definitions."
},
"response": [
{
"name": "Prediction models",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/1OR5Y0000010ws8WAA/models",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predictionDefinitions",
"1OR5Y0000010ws8WAA",
"models"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 04 Mar 2021 13:48:31 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 \"models\": [\n {\n \"createdBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"createdDate\": \"2021-03-04T13:37:03.000Z\",\n \"fieldMappingList\": [\n {\n \"modelField\": {\n \"label\": \"Category\",\n \"name\": \"Category\",\n \"type\": \"Text\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Sales\",\n \"name\": \"Sales\",\n \"type\": \"Number\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Profit per Order\",\n \"name\": \"Profit_per_Order\",\n \"type\": \"Number\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Sub-Category\",\n \"name\": \"Sub_Category\",\n \"type\": \"Text\"\n }\n },\n {\n \"modelField\": {\n \"label\": \"Quantity\",\n \"name\": \"Quantity\",\n \"type\": \"Number\"\n }\n }\n ],\n \"filters\": [],\n \"historyUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ/histories\",\n \"id\": \"1Ot5Y0000010wzNSAQ\",\n \"isRefreshEnabled\": false,\n \"label\": \"superstore-orders\",\n \"lastModifiedBy\": {\n \"id\": \"0055Y00000DWwAIQA1\",\n \"name\": \"Philippe Ozil\",\n \"profilePhotoUrl\": \"https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T\"\n },\n \"lastModifiedDate\": \"2021-03-04T13:37:03.000Z\",\n \"model\": {\n \"id\": \"1OT5Y0000010zlzWAA\"\n },\n \"modelType\": \"Regression\",\n \"name\": \"superstore_orders\",\n \"predictionDefinitionUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA\",\n \"prescribableFields\": [\n {\n \"customDefinitions\": [],\n \"field\": {\n \"label\": \"Quantity\",\n \"name\": \"Quantity\",\n \"type\": \"Number\"\n }\n }\n ],\n \"sortOrder\": 0,\n \"status\": \"Enabled\",\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models/1Ot5Y0000010wzNSAQ\"\n }\n ],\n \"totalSize\": 1,\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models\"\n}"
}
]
}
