Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set totalSize [CkJsonObject_IntOf $jResp "totalSize"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "models"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set Id [CkJsonObject_stringOf $jResp "models[i].createdBy.id"]
set Name [CkJsonObject_stringOf $jResp "models[i].createdBy.name"]
set ProfilePhotoUrl [CkJsonObject_stringOf $jResp "models[i].createdBy.profilePhotoUrl"]
set createdDate [CkJsonObject_stringOf $jResp "models[i].createdDate"]
set historyUrl [CkJsonObject_stringOf $jResp "models[i].historyUrl"]
set id [CkJsonObject_stringOf $jResp "models[i].id"]
set isRefreshEnabled [CkJsonObject_BoolOf $jResp "models[i].isRefreshEnabled"]
set label [CkJsonObject_stringOf $jResp "models[i].label"]
set lastModifiedById [CkJsonObject_stringOf $jResp "models[i].lastModifiedBy.id"]
set lastModifiedByName [CkJsonObject_stringOf $jResp "models[i].lastModifiedBy.name"]
set lastModifiedByProfilePhotoUrl [CkJsonObject_stringOf $jResp "models[i].lastModifiedBy.profilePhotoUrl"]
set lastModifiedDate [CkJsonObject_stringOf $jResp "models[i].lastModifiedDate"]
set modelId [CkJsonObject_stringOf $jResp "models[i].model.id"]
set modelType [CkJsonObject_stringOf $jResp "models[i].modelType"]
set name [CkJsonObject_stringOf $jResp "models[i].name"]
set predictionDefinitionUrl [CkJsonObject_stringOf $jResp "models[i].predictionDefinitionUrl"]
set sortOrder [CkJsonObject_IntOf $jResp "models[i].sortOrder"]
set status [CkJsonObject_stringOf $jResp "models[i].status"]
set url [CkJsonObject_stringOf $jResp "models[i].url"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "models[i].fieldMappingList"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set Label [CkJsonObject_stringOf $jResp "models[i].fieldMappingList[j].modelField.label"]
set modelFieldName [CkJsonObject_stringOf $jResp "models[i].fieldMappingList[j].modelField.name"]
set v_Type [CkJsonObject_stringOf $jResp "models[i].fieldMappingList[j].modelField.type"]
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "models[i].filters"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set j [expr $j + 1]
}
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "models[i].prescribableFields"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set fieldLabel [CkJsonObject_stringOf $jResp "models[i].prescribableFields[j].field.label"]
set fieldName [CkJsonObject_stringOf $jResp "models[i].prescribableFields[j].field.name"]
set fieldType [CkJsonObject_stringOf $jResp "models[i].prescribableFields[j].field.type"]
set k 0
set count_k [CkJsonObject_SizeOfArray $jResp "models[i].prescribableFields[j].customDefinitions"]
while {$k < $count_k} {
CkJsonObject_put_K $jResp $k
set k [expr $k + 1]
}
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
