Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sName
Local $sProfilePhotoUrl
Local $sCreatedDate
Local $sHistoryUrl
Local $sId
Local $bIsRefreshEnabled
Local $sLabel
Local $sLastModifiedById
Local $sLastModifiedByName
Local $sLastModifiedByProfilePhotoUrl
Local $sLastModifiedDate
Local $sModelId
Local $sModelType
Local $sName
Local $sPredictionDefinitionUrl
Local $iSortOrder
Local $status
Local $iJ
Local $iCount_j
Local $sLabel
Local $sModelFieldName
Local $sV_Type
Local $sFieldLabel
Local $sFieldName
Local $sFieldType
Local $iK
Local $iCount_k
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("models")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("models[i].createdBy.id")
$sName = $oJResp.StringOf("models[i].createdBy.name")
$sProfilePhotoUrl = $oJResp.StringOf("models[i].createdBy.profilePhotoUrl")
$sCreatedDate = $oJResp.StringOf("models[i].createdDate")
$sHistoryUrl = $oJResp.StringOf("models[i].historyUrl")
$sId = $oJResp.StringOf("models[i].id")
$bIsRefreshEnabled = $oJResp.BoolOf("models[i].isRefreshEnabled")
$sLabel = $oJResp.StringOf("models[i].label")
$sLastModifiedById = $oJResp.StringOf("models[i].lastModifiedBy.id")
$sLastModifiedByName = $oJResp.StringOf("models[i].lastModifiedBy.name")
$sLastModifiedByProfilePhotoUrl = $oJResp.StringOf("models[i].lastModifiedBy.profilePhotoUrl")
$sLastModifiedDate = $oJResp.StringOf("models[i].lastModifiedDate")
$sModelId = $oJResp.StringOf("models[i].model.id")
$sModelType = $oJResp.StringOf("models[i].modelType")
$sName = $oJResp.StringOf("models[i].name")
$sPredictionDefinitionUrl = $oJResp.StringOf("models[i].predictionDefinitionUrl")
$iSortOrder = $oJResp.IntOf("models[i].sortOrder")
$status = $oJResp.StringOf("models[i].status")
$sUrl = $oJResp.StringOf("models[i].url")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("models[i].fieldMappingList")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sLabel = $oJResp.StringOf("models[i].fieldMappingList[j].modelField.label")
$sModelFieldName = $oJResp.StringOf("models[i].fieldMappingList[j].modelField.name")
$sV_Type = $oJResp.StringOf("models[i].fieldMappingList[j].modelField.type")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("models[i].filters")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("models[i].prescribableFields")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sFieldLabel = $oJResp.StringOf("models[i].prescribableFields[j].field.label")
$sFieldName = $oJResp.StringOf("models[i].prescribableFields[j].field.name")
$sFieldType = $oJResp.StringOf("models[i].prescribableFields[j].field.type")
$iK = 0
$iCount_k = $oJResp.SizeOfArray("models[i].prescribableFields[j].customDefinitions")
While $iK < $iCount_k
$oJResp.K = $iK
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
