Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# 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")
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}"
}
]
}
