Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
countOfActiveModels.i
countOfModels.i
Id.s
Name.s
ProfilePhotoUrl.s
createdDate.s
id.s
label.s
lastModifiedById.s
lastModifiedByName.s
lastModifiedByProfilePhotoUrl.s
lastModifiedDate.s
modelsUrl.s
name.s
Goal.s
Label.s
outcomeName.s
predictionType.s
status.s
nextPageUrl.s = CkJsonObject::ckStringOf(jResp,"nextPageUrl")
totalSize.i = CkJsonObject::ckIntOf(jResp,"totalSize")
url.s = CkJsonObject::ckStringOf(jResp,"url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"predictionDefinitions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
countOfActiveModels = CkJsonObject::ckIntOf(jResp,"predictionDefinitions[i].countOfActiveModels")
countOfModels = CkJsonObject::ckIntOf(jResp,"predictionDefinitions[i].countOfModels")
Id = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].createdBy.id")
Name = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].createdBy.name")
ProfilePhotoUrl = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].createdBy.profilePhotoUrl")
createdDate = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].createdDate")
id = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].id")
label = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].label")
lastModifiedById = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].lastModifiedBy.id")
lastModifiedByName = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].lastModifiedBy.name")
lastModifiedByProfilePhotoUrl = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].lastModifiedBy.profilePhotoUrl")
lastModifiedDate = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].lastModifiedDate")
modelsUrl = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].modelsUrl")
name = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].name")
Goal = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].outcome.goal")
Label = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].outcome.label")
outcomeName = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].outcome.name")
predictionType = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].predictionType")
status = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].status")
url = CkJsonObject::ckStringOf(jResp,"predictionDefinitions[i].url")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
