Chilkat Online Tools

Go / Salesforce Platform APIs / Prediction models

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    // Adds the "Authorization: Bearer <access_token>" header.
    http.SetAuthToken("<access_token>")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    // 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

    var Id *string = new(string)
    var Name *string = new(string)
    var ProfilePhotoUrl *string = new(string)
    var createdDate *string = new(string)
    var historyUrl *string = new(string)
    var id *string = new(string)
    var isRefreshEnabled bool
    var label *string = new(string)
    var lastModifiedById *string = new(string)
lastModifiedBy    var Name *string = new(string)
    var lastModifiedByProfilePhotoUrl *string = new(string)
    var lastModifiedDate *string = new(string)
model    var Id *string = new(string)
    var modelType *string = new(string)
    var name *string = new(string)
    var predictionDefinitionUrl *string = new(string)
    var sortOrder int
    var status *string = new(string)
    var j int
    var count_j int
    var Label *string = new(string)
modelField    var Name *string = new(string)
    var v_Type *string = new(string)
field    var Label *string = new(string)
    var fieldName *string = new(string)
    var fieldType *string = new(string)
    var k int
    var count_k int

    totalSize := jResp.IntOf("totalSize")
    url := jResp.StringOf("url")
    i := 0
    count_i := jResp.SizeOfArray("models")
    for i < count_i {
        jResp.SetI(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")
        for j < count_j {
            jResp.SetJ(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
        }

        j = 0
        count_j = jResp.SizeOfArray("models[i].filters")
        for j < count_j {
            jResp.SetJ(j)
            j = j + 1
        }

        j = 0
        count_j = jResp.SizeOfArray("models[i].prescribableFields")
        for j < count_j {
            jResp.SetJ(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")
            for k < count_k {
                jResp.SetK(k)
                k = k + 1
            }

            j = j + 1
        }

        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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