Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
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
totalSize = jResp.IntOf("totalSize")
url = jResp.stringOf("url")
i = 0
count_i = jResp.SizeOfArray("models")
while i < count_i
jResp.put_I(i)
Id = jResp.stringOf("models[i].createdBy.id")
Name = jResp.stringOf("models[i].createdBy.name")
ProfilePhotoUrl = jResp.stringOf("models[i].createdBy.profilePhotoUrl")
createdDate = jResp.stringOf("models[i].createdDate")
historyUrl = jResp.stringOf("models[i].historyUrl")
id = jResp.stringOf("models[i].id")
isRefreshEnabled = jResp.BoolOf("models[i].isRefreshEnabled")
label = jResp.stringOf("models[i].label")
lastModifiedById = jResp.stringOf("models[i].lastModifiedBy.id")
lastModifiedByName = jResp.stringOf("models[i].lastModifiedBy.name")
lastModifiedByProfilePhotoUrl = jResp.stringOf("models[i].lastModifiedBy.profilePhotoUrl")
lastModifiedDate = jResp.stringOf("models[i].lastModifiedDate")
modelId = jResp.stringOf("models[i].model.id")
modelType = jResp.stringOf("models[i].modelType")
name = jResp.stringOf("models[i].name")
predictionDefinitionUrl = jResp.stringOf("models[i].predictionDefinitionUrl")
sortOrder = jResp.IntOf("models[i].sortOrder")
status = jResp.stringOf("models[i].status")
url = jResp.stringOf("models[i].url")
j = 0
count_j = jResp.SizeOfArray("models[i].fieldMappingList")
while j < count_j
jResp.put_J(j)
Label = jResp.stringOf("models[i].fieldMappingList[j].modelField.label")
modelFieldName = jResp.stringOf("models[i].fieldMappingList[j].modelField.name")
v_Type = jResp.stringOf("models[i].fieldMappingList[j].modelField.type")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("models[i].filters")
while j < count_j
jResp.put_J(j)
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("models[i].prescribableFields")
while j < count_j
jResp.put_J(j)
fieldLabel = jResp.stringOf("models[i].prescribableFields[j].field.label")
fieldName = jResp.stringOf("models[i].prescribableFields[j].field.name")
fieldType = jResp.stringOf("models[i].prescribableFields[j].field.type")
k = 0
count_k = jResp.SizeOfArray("models[i].prescribableFields[j].customDefinitions")
while k < count_k
jResp.put_K(k)
k = k + 1
end
j = j + 1
end
i = i + 1
end
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}"
}
]
}
