Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnCountOfActiveModels
LOCAL lnCountOfModels
LOCAL lcId
LOCAL lcName
LOCAL lcProfilePhotoUrl
LOCAL lcCreatedDate
LOCAL lcId
LOCAL lcLabel
LOCAL lcLastModifiedById
LOCAL lcLastModifiedByName
LOCAL lcLastModifiedByProfilePhotoUrl
LOCAL lcLastModifiedDate
LOCAL lcModelsUrl
LOCAL lcName
LOCAL lcGoal
LOCAL lcLabel
LOCAL lcOutcomeName
LOCAL lcPredictionType
LOCAL lcStatus
LOCAL lcNextPageUrl
LOCAL lnTotalSize
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lcNextPageUrl = loJResp.StringOf("nextPageUrl")
lnTotalSize = loJResp.IntOf("totalSize")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("predictionDefinitions")
DO WHILE i < lnCount_i
loJResp.I = i
lnCountOfActiveModels = loJResp.IntOf("predictionDefinitions[i].countOfActiveModels")
lnCountOfModels = loJResp.IntOf("predictionDefinitions[i].countOfModels")
lcId = loJResp.StringOf("predictionDefinitions[i].createdBy.id")
lcName = loJResp.StringOf("predictionDefinitions[i].createdBy.name")
lcProfilePhotoUrl = loJResp.StringOf("predictionDefinitions[i].createdBy.profilePhotoUrl")
lcCreatedDate = loJResp.StringOf("predictionDefinitions[i].createdDate")
lcId = loJResp.StringOf("predictionDefinitions[i].id")
lcLabel = loJResp.StringOf("predictionDefinitions[i].label")
lcLastModifiedById = loJResp.StringOf("predictionDefinitions[i].lastModifiedBy.id")
lcLastModifiedByName = loJResp.StringOf("predictionDefinitions[i].lastModifiedBy.name")
lcLastModifiedByProfilePhotoUrl = loJResp.StringOf("predictionDefinitions[i].lastModifiedBy.profilePhotoUrl")
lcLastModifiedDate = loJResp.StringOf("predictionDefinitions[i].lastModifiedDate")
lcModelsUrl = loJResp.StringOf("predictionDefinitions[i].modelsUrl")
lcName = loJResp.StringOf("predictionDefinitions[i].name")
lcGoal = loJResp.StringOf("predictionDefinitions[i].outcome.goal")
lcLabel = loJResp.StringOf("predictionDefinitions[i].outcome.label")
lcOutcomeName = loJResp.StringOf("predictionDefinitions[i].outcome.name")
lcPredictionType = loJResp.StringOf("predictionDefinitions[i].predictionType")
lcStatus = loJResp.StringOf("predictionDefinitions[i].status")
lcUrl = loJResp.StringOf("predictionDefinitions[i].url")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
