Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// 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
int countOfActiveModels;
int countOfModels;
NSString *Id = 0;
NSString *Name = 0;
NSString *ProfilePhotoUrl = 0;
NSString *createdDate = 0;
NSString *id = 0;
NSString *label = 0;
NSString *lastModifiedById = 0;
NSString *lastModifiedByName = 0;
NSString *lastModifiedByProfilePhotoUrl = 0;
NSString *lastModifiedDate = 0;
NSString *modelsUrl = 0;
NSString *name = 0;
NSString *Goal = 0;
NSString *Label = 0;
NSString *outcomeName = 0;
NSString *predictionType = 0;
NSString *status = 0;
NSString *nextPageUrl = [jResp StringOf: @"nextPageUrl"];
int totalSize = [[jResp IntOf: @"totalSize"] intValue];
NSString *url = [jResp StringOf: @"url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"predictionDefinitions"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
countOfActiveModels = [[jResp IntOf: @"predictionDefinitions[i].countOfActiveModels"] intValue];
countOfModels = [[jResp IntOf: @"predictionDefinitions[i].countOfModels"] intValue];
Id = [jResp StringOf: @"predictionDefinitions[i].createdBy.id"];
Name = [jResp StringOf: @"predictionDefinitions[i].createdBy.name"];
ProfilePhotoUrl = [jResp StringOf: @"predictionDefinitions[i].createdBy.profilePhotoUrl"];
createdDate = [jResp StringOf: @"predictionDefinitions[i].createdDate"];
id = [jResp StringOf: @"predictionDefinitions[i].id"];
label = [jResp StringOf: @"predictionDefinitions[i].label"];
lastModifiedById = [jResp StringOf: @"predictionDefinitions[i].lastModifiedBy.id"];
lastModifiedByName = [jResp StringOf: @"predictionDefinitions[i].lastModifiedBy.name"];
lastModifiedByProfilePhotoUrl = [jResp StringOf: @"predictionDefinitions[i].lastModifiedBy.profilePhotoUrl"];
lastModifiedDate = [jResp StringOf: @"predictionDefinitions[i].lastModifiedDate"];
modelsUrl = [jResp StringOf: @"predictionDefinitions[i].modelsUrl"];
name = [jResp StringOf: @"predictionDefinitions[i].name"];
Goal = [jResp StringOf: @"predictionDefinitions[i].outcome.goal"];
Label = [jResp StringOf: @"predictionDefinitions[i].outcome.label"];
outcomeName = [jResp StringOf: @"predictionDefinitions[i].outcome.name"];
predictionType = [jResp StringOf: @"predictionDefinitions[i].predictionType"];
status = [jResp StringOf: @"predictionDefinitions[i].status"];
url = [jResp StringOf: @"predictionDefinitions[i].url"];
i = i + 1;
}
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}"
}
]
}
