Chilkat Online Tools

autoit / Salesforce Platform APIs / Prediction definitions

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",$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)

; {
;   "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

Local $iCountOfActiveModels
Local $iCountOfModels
Local $sId
Local $sName
Local $sProfilePhotoUrl
Local $sCreatedDate
Local $sId
Local $sLabel
Local $sLastModifiedById
Local $sLastModifiedByName
Local $sLastModifiedByProfilePhotoUrl
Local $sLastModifiedDate
Local $sModelsUrl
Local $sName
Local $sGoal
Local $sLabel
Local $sOutcomeName
Local $sPredictionType
Local $status

Local $sNextPageUrl = $oJResp.StringOf("nextPageUrl")
Local $iTotalSize = $oJResp.IntOf("totalSize")
Local $sUrl = $oJResp.StringOf("url")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("predictionDefinitions")
While $i < $iCount_i
    $oJResp.I = $i
    $iCountOfActiveModels = $oJResp.IntOf("predictionDefinitions[i].countOfActiveModels")
    $iCountOfModels = $oJResp.IntOf("predictionDefinitions[i].countOfModels")
    $sId = $oJResp.StringOf("predictionDefinitions[i].createdBy.id")
    $sName = $oJResp.StringOf("predictionDefinitions[i].createdBy.name")
    $sProfilePhotoUrl = $oJResp.StringOf("predictionDefinitions[i].createdBy.profilePhotoUrl")
    $sCreatedDate = $oJResp.StringOf("predictionDefinitions[i].createdDate")
    $sId = $oJResp.StringOf("predictionDefinitions[i].id")
    $sLabel = $oJResp.StringOf("predictionDefinitions[i].label")
    $sLastModifiedById = $oJResp.StringOf("predictionDefinitions[i].lastModifiedBy.id")
    $sLastModifiedByName = $oJResp.StringOf("predictionDefinitions[i].lastModifiedBy.name")
    $sLastModifiedByProfilePhotoUrl = $oJResp.StringOf("predictionDefinitions[i].lastModifiedBy.profilePhotoUrl")
    $sLastModifiedDate = $oJResp.StringOf("predictionDefinitions[i].lastModifiedDate")
    $sModelsUrl = $oJResp.StringOf("predictionDefinitions[i].modelsUrl")
    $sName = $oJResp.StringOf("predictionDefinitions[i].name")
    $sGoal = $oJResp.StringOf("predictionDefinitions[i].outcome.goal")
    $sLabel = $oJResp.StringOf("predictionDefinitions[i].outcome.label")
    $sOutcomeName = $oJResp.StringOf("predictionDefinitions[i].outcome.name")
    $sPredictionType = $oJResp.StringOf("predictionDefinitions[i].predictionType")
    $status = $oJResp.StringOf("predictionDefinitions[i].status")
    $sUrl = $oJResp.StringOf("predictionDefinitions[i].url")
    $i = $i + 1
Wend

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}"
    }
  ]
}