Chilkat Online Tools

Go / Salesforce Platform APIs / Prediction definition metadata

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

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

    countOfActiveModels := jResp.IntOf("countOfActiveModels")
    countOfModels := jResp.IntOf("countOfModels")
    Id := jResp.StringOf("createdBy.id")
    Name := jResp.StringOf("createdBy.name")
    ProfilePhotoUrl := jResp.StringOf("createdBy.profilePhotoUrl")
    createdDate := jResp.StringOf("createdDate")
    id := jResp.StringOf("id")
    label := jResp.StringOf("label")
    lastModifiedById := jResp.StringOf("lastModifiedBy.id")
    lastModifiedByName := jResp.StringOf("lastModifiedBy.name")
    lastModifiedByProfilePhotoUrl := jResp.StringOf("lastModifiedBy.profilePhotoUrl")
    lastModifiedDate := jResp.StringOf("lastModifiedDate")
    modelsUrl := jResp.StringOf("modelsUrl")
    name := jResp.StringOf("name")
    Goal := jResp.StringOf("outcome.goal")
    Label := jResp.StringOf("outcome.label")
    outcomeName := jResp.StringOf("outcome.name")
    predictionType := jResp.StringOf("predictionType")
    status := jResp.StringOf("status")
    url := jResp.StringOf("url")

    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

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