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" $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)
# {
# "nextPageUrl": null,
# "predictionDefinitions": [
# {
# "countOfActiveModels": 1,
# "countOfModels": 1,
# "createdBy": {
# "id": "0055Y00000DWwAIQA1",
# "name": "Philippe Ozil",
# "profilePhotoUrl": "https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T"
# },
# "createdDate": "2021-03-04T13:37:02.000Z",
# "id": "1OR5Y0000010ws8WAA",
# "label": "Sales_per_Customer",
# "lastModifiedBy": {
# "id": "0055Y00000DWwAIQA1",
# "name": "Philippe Ozil",
# "profilePhotoUrl": "https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T"
# },
# "lastModifiedDate": "2021-03-04T13:37:02.000Z",
# "modelsUrl": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models",
# "name": "Sales_per_Customer",
# "outcome": {
# "goal": "Maximize",
# "label": "Sales per Customer",
# "name": "Sales_per_Customer"
# },
# "predictionType": "Regression",
# "status": "Enabled",
# "url": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA"
# }
# ],
# "totalSize": 1,
# "url": "/services/data/v51.0/smartdatadiscovery/predictiondefinitions?pageSize=25"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set nextPageUrl [CkJsonObject_stringOf $jResp "nextPageUrl"]
set totalSize [CkJsonObject_IntOf $jResp "totalSize"]
set url [CkJsonObject_stringOf $jResp "url"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "predictionDefinitions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set countOfActiveModels [CkJsonObject_IntOf $jResp "predictionDefinitions[i].countOfActiveModels"]
set countOfModels [CkJsonObject_IntOf $jResp "predictionDefinitions[i].countOfModels"]
set Id [CkJsonObject_stringOf $jResp "predictionDefinitions[i].createdBy.id"]
set Name [CkJsonObject_stringOf $jResp "predictionDefinitions[i].createdBy.name"]
set ProfilePhotoUrl [CkJsonObject_stringOf $jResp "predictionDefinitions[i].createdBy.profilePhotoUrl"]
set createdDate [CkJsonObject_stringOf $jResp "predictionDefinitions[i].createdDate"]
set id [CkJsonObject_stringOf $jResp "predictionDefinitions[i].id"]
set label [CkJsonObject_stringOf $jResp "predictionDefinitions[i].label"]
set lastModifiedById [CkJsonObject_stringOf $jResp "predictionDefinitions[i].lastModifiedBy.id"]
set lastModifiedByName [CkJsonObject_stringOf $jResp "predictionDefinitions[i].lastModifiedBy.name"]
set lastModifiedByProfilePhotoUrl [CkJsonObject_stringOf $jResp "predictionDefinitions[i].lastModifiedBy.profilePhotoUrl"]
set lastModifiedDate [CkJsonObject_stringOf $jResp "predictionDefinitions[i].lastModifiedDate"]
set modelsUrl [CkJsonObject_stringOf $jResp "predictionDefinitions[i].modelsUrl"]
set name [CkJsonObject_stringOf $jResp "predictionDefinitions[i].name"]
set Goal [CkJsonObject_stringOf $jResp "predictionDefinitions[i].outcome.goal"]
set Label [CkJsonObject_stringOf $jResp "predictionDefinitions[i].outcome.label"]
set outcomeName [CkJsonObject_stringOf $jResp "predictionDefinitions[i].outcome.name"]
set predictionType [CkJsonObject_stringOf $jResp "predictionDefinitions[i].predictionType"]
set status [CkJsonObject_stringOf $jResp "predictionDefinitions[i].status"]
set url [CkJsonObject_stringOf $jResp "predictionDefinitions[i].url"]
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
Postman Collection Item JSON
{
"name": "Prediction definitions",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predictionDefinitions"
]
},
"description": "Get available prediction definitions."
},
"response": [
{
"name": "Prediction definitions",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predictionDefinitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 04 Mar 2021 13:45:15 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 \"nextPageUrl\": null,\n \"predictionDefinitions\": [\n {\n \"countOfActiveModels\": 1,\n \"countOfModels\": 1,\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:02.000Z\",\n \"id\": \"1OR5Y0000010ws8WAA\",\n \"label\": \"Sales_per_Customer\",\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:02.000Z\",\n \"modelsUrl\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models\",\n \"name\": \"Sales_per_Customer\",\n \"outcome\": {\n \"goal\": \"Maximize\",\n \"label\": \"Sales per Customer\",\n \"name\": \"Sales_per_Customer\"\n },\n \"predictionType\": \"Regression\",\n \"status\": \"Enabled\",\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA\"\n }\n ],\n \"totalSize\": 1,\n \"url\": \"/services/data/v51.0/smartdatadiscovery/predictiondefinitions?pageSize=25\"\n}"
}
]
}
