Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sName
String sProfilePhotoUrl
String sCreatedDate
String sHistoryUrl
String sId
Boolean iIsRefreshEnabled
String sLabel
String sLastModifiedById
String sLastModifiedByName
String sLastModifiedByProfilePhotoUrl
String sLastModifiedDate
String sModelId
String sModelType
String sName
String sPredictionDefinitionUrl
Integer iSortOrder
String sStatus
Integer j
Integer iCount_j
String sLabel
String sModelFieldName
String sV_Type
String sFieldLabel
String sFieldName
String sFieldType
Integer k
Integer iCount_k
Integer iTotalSize
String sUrl
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID/models" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComIntOf Of hoJResp "totalSize" To iTotalSize
Get ComStringOf Of hoJResp "url" To sUrl
Move 0 To i
Get ComSizeOfArray Of hoJResp "models" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "models[i].createdBy.id" To sId
Get ComStringOf Of hoJResp "models[i].createdBy.name" To sName
Get ComStringOf Of hoJResp "models[i].createdBy.profilePhotoUrl" To sProfilePhotoUrl
Get ComStringOf Of hoJResp "models[i].createdDate" To sCreatedDate
Get ComStringOf Of hoJResp "models[i].historyUrl" To sHistoryUrl
Get ComStringOf Of hoJResp "models[i].id" To sId
Get ComBoolOf Of hoJResp "models[i].isRefreshEnabled" To iIsRefreshEnabled
Get ComStringOf Of hoJResp "models[i].label" To sLabel
Get ComStringOf Of hoJResp "models[i].lastModifiedBy.id" To sLastModifiedById
Get ComStringOf Of hoJResp "models[i].lastModifiedBy.name" To sLastModifiedByName
Get ComStringOf Of hoJResp "models[i].lastModifiedBy.profilePhotoUrl" To sLastModifiedByProfilePhotoUrl
Get ComStringOf Of hoJResp "models[i].lastModifiedDate" To sLastModifiedDate
Get ComStringOf Of hoJResp "models[i].model.id" To sModelId
Get ComStringOf Of hoJResp "models[i].modelType" To sModelType
Get ComStringOf Of hoJResp "models[i].name" To sName
Get ComStringOf Of hoJResp "models[i].predictionDefinitionUrl" To sPredictionDefinitionUrl
Get ComIntOf Of hoJResp "models[i].sortOrder" To iSortOrder
Get ComStringOf Of hoJResp "models[i].status" To sStatus
Get ComStringOf Of hoJResp "models[i].url" To sUrl
Move 0 To j
Get ComSizeOfArray Of hoJResp "models[i].fieldMappingList" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "models[i].fieldMappingList[j].modelField.label" To sLabel
Get ComStringOf Of hoJResp "models[i].fieldMappingList[j].modelField.name" To sModelFieldName
Get ComStringOf Of hoJResp "models[i].fieldMappingList[j].modelField.type" To sV_Type
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "models[i].filters" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "models[i].prescribableFields" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "models[i].prescribableFields[j].field.label" To sFieldLabel
Get ComStringOf Of hoJResp "models[i].prescribableFields[j].field.name" To sFieldName
Get ComStringOf Of hoJResp "models[i].prescribableFields[j].field.type" To sFieldType
Move 0 To k
Get ComSizeOfArray Of hoJResp "models[i].prescribableFields[j].customDefinitions" To iCount_k
While (k < iCount_k)
Set ComK Of hoJResp To k
Move (k + 1) To k
Loop
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
