Chilkat Online Tools

autoit / Salesforce Platform APIs / Prediction definition metadata

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

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

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $iCountOfActiveModels = $oJResp.IntOf("countOfActiveModels")
Local $iCountOfModels = $oJResp.IntOf("countOfModels")
Local $sId = $oJResp.StringOf("createdBy.id")
Local $sName = $oJResp.StringOf("createdBy.name")
Local $sProfilePhotoUrl = $oJResp.StringOf("createdBy.profilePhotoUrl")
Local $sCreatedDate = $oJResp.StringOf("createdDate")
Local $sId = $oJResp.StringOf("id")
Local $sLabel = $oJResp.StringOf("label")
Local $sLastModifiedById = $oJResp.StringOf("lastModifiedBy.id")
Local $sLastModifiedByName = $oJResp.StringOf("lastModifiedBy.name")
Local $sLastModifiedByProfilePhotoUrl = $oJResp.StringOf("lastModifiedBy.profilePhotoUrl")
Local $sLastModifiedDate = $oJResp.StringOf("lastModifiedDate")
Local $sModelsUrl = $oJResp.StringOf("modelsUrl")
Local $sName = $oJResp.StringOf("name")
Local $sGoal = $oJResp.StringOf("outcome.goal")
Local $sLabel = $oJResp.StringOf("outcome.label")
Local $sOutcomeName = $oJResp.StringOf("outcome.name")
Local $sPredictionType = $oJResp.StringOf("predictionType")
Local $status = $oJResp.StringOf("status")
Local $sUrl = $oJResp.StringOf("url")

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID

Postman Collection Item JSON

{
  "name": "Prediction definition metadata",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "smartdatadiscovery",
        "predictionDefinitions",
        ":PREDICTION_DEFINITION_ID"
      ],
      "variable": [
        {
          "key": "PREDICTION_DEFINITION_ID",
          "value": ""
        }
      ]
    },
    "description": "Get available prediction definitions."
  },
  "response": [
    {
      "name": "Prediction definition metadata",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/1OR5Y0000010ws8WAA",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "smartdatadiscovery",
            "predictionDefinitions",
            "1OR5Y0000010ws8WAA"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 04 Mar 2021 13:45:58 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    \"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}"
    }
  ]
}