Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "predictionDefinition": "<PREDICTION_DEFINITION_ID>",
; "type": "RawData",
; "columnNames": [
; "Quantity",
; "Category",
; "Sub_Category",
; "Sales",
; "Profit_per_Order"
; ],
; "rows": [
; [
; "2",
; "Furniture",
; "Chairs",
; "300",
; "10"
; ]
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"predictionDefinition","<PREDICTION_DEFINITION_ID>")
CkJsonObject::ckUpdateString(json,"type","RawData")
CkJsonObject::ckUpdateString(json,"columnNames[0]","Quantity")
CkJsonObject::ckUpdateString(json,"columnNames[1]","Category")
CkJsonObject::ckUpdateString(json,"columnNames[2]","Sub_Category")
CkJsonObject::ckUpdateString(json,"columnNames[3]","Sales")
CkJsonObject::ckUpdateString(json,"columnNames[4]","Profit_per_Order")
CkJsonObject::ckUpdateString(json,"rows[0][0]","2")
CkJsonObject::ckUpdateString(json,"rows[0][1]","Furniture")
CkJsonObject::ckUpdateString(json,"rows[0][2]","Chairs")
CkJsonObject::ckUpdateString(json,"rows[0][3]","300")
CkJsonObject::ckUpdateString(json,"rows[0][4]","10")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "predictionDefinition": "1OR5Y0000010ws8",
; "predictions": [
; {
; "model": {
; "id": "1Ot5Y0000010wzNSAQ"
; },
; "prediction": {
; "middleValues": [
; ],
; "total": 88.52494255547592
; },
; "prescriptions": [
; ],
; "status": "Success"
; }
; ],
; "settings": {
; "maxMiddleValues": 0,
; "maxPrescriptions": 0,
; "prescriptionImpactPercentage": 0
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id.s
Total.s
status.s
j.i
count_j.i
predictionDefinition.s = CkJsonObject::ckStringOf(jResp,"predictionDefinition")
MaxMiddleValues.i = CkJsonObject::ckIntOf(jResp,"settings.maxMiddleValues")
MaxPrescriptions.i = CkJsonObject::ckIntOf(jResp,"settings.maxPrescriptions")
PrescriptionImpactPercentage.i = CkJsonObject::ckIntOf(jResp,"settings.prescriptionImpactPercentage")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"predictions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Id = CkJsonObject::ckStringOf(jResp,"predictions[i].model.id")
Total = CkJsonObject::ckStringOf(jResp,"predictions[i].prediction.total")
status = CkJsonObject::ckStringOf(jResp,"predictions[i].status")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"predictions[i].prediction.middleValues")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"predictions[i].prescriptions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"predictionDefinition": "<PREDICTION_DEFINITION_ID>",
"type": "RawData",
"columnNames": [
"Quantity",
"Category",
"Sub_Category",
"Sales",
"Profit_per_Order"
],
"rows": [
[
"2",
"Furniture",
"Chairs",
"300",
"10"
]
]
}'
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predict
Postman Collection Item JSON
{
"name": "Predict",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"predictionDefinition\": \"<PREDICTION_DEFINITION_ID>\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predict"
]
},
"description": "Get available prediction definitions."
},
"response": [
{
"name": "Predict",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"predictionDefinition\": \"1OR5Y0000010ws8WAA\",\n \"type\": \"RawData\",\n \"columnNames\": [\n \"Quantity\",\n \"Category\",\n \"Sub_Category\",\n \"Sales\",\n \"Profit_per_Order\"\n ],\n \"rows\": [\n [\n \"2\",\n \"Furniture\",\n \"Chairs\",\n \"300\",\n \"10\"\n ]\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predict",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"smartdatadiscovery",
"predict"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 04 Mar 2021 13:53:39 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 \"predictionDefinition\": \"1OR5Y0000010ws8\",\n \"predictions\": [\n {\n \"model\": {\n \"id\": \"1Ot5Y0000010wzNSAQ\"\n },\n \"prediction\": {\n \"middleValues\": [],\n \"total\": 88.52494255547592\n },\n \"prescriptions\": [],\n \"status\": \"Success\"\n }\n ],\n \"settings\": {\n \"maxMiddleValues\": 0,\n \"maxPrescriptions\": 0,\n \"prescriptionImpactPercentage\": 0\n }\n}"
}
]
}
