Chilkat Online Tools

DataFlex / Salesforce Platform APIs / Prediction definition metadata

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    Integer iCountOfActiveModels
    Integer iCountOfModels
    String sId
    String sName
    String sProfilePhotoUrl
    String sCreatedDate
    String sId
    String sLabel
    String sLastModifiedById
    String sLastModifiedByName
    String sLastModifiedByProfilePhotoUrl
    String sLastModifiedDate
    String sModelsUrl
    String sName
    String sGoal
    String sLabel
    String sOutcomeName
    String sPredictionType
    String sStatus
    String sUrl
    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" 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)

    // {
    //   "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"
    // }

    // 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 "countOfActiveModels" To iCountOfActiveModels
    Get ComIntOf Of hoJResp "countOfModels" To iCountOfModels
    Get ComStringOf Of hoJResp "createdBy.id" To sId
    Get ComStringOf Of hoJResp "createdBy.name" To sName
    Get ComStringOf Of hoJResp "createdBy.profilePhotoUrl" To sProfilePhotoUrl
    Get ComStringOf Of hoJResp "createdDate" To sCreatedDate
    Get ComStringOf Of hoJResp "id" To sId
    Get ComStringOf Of hoJResp "label" To sLabel
    Get ComStringOf Of hoJResp "lastModifiedBy.id" To sLastModifiedById
    Get ComStringOf Of hoJResp "lastModifiedBy.name" To sLastModifiedByName
    Get ComStringOf Of hoJResp "lastModifiedBy.profilePhotoUrl" To sLastModifiedByProfilePhotoUrl
    Get ComStringOf Of hoJResp "lastModifiedDate" To sLastModifiedDate
    Get ComStringOf Of hoJResp "modelsUrl" To sModelsUrl
    Get ComStringOf Of hoJResp "name" To sName
    Get ComStringOf Of hoJResp "outcome.goal" To sGoal
    Get ComStringOf Of hoJResp "outcome.label" To sLabel
    Get ComStringOf Of hoJResp "outcome.name" To sOutcomeName
    Get ComStringOf Of hoJResp "predictionType" To sPredictionType
    Get ComStringOf Of hoJResp "status" To sStatus
    Get ComStringOf Of hoJResp "url" To sUrl


End_Procedure

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID

Postman Collection Item JSON

{
  "name": "Prediction definition metadata",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/:PREDICTION_DEFINITION_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "smartdatadiscovery",
        "predictionDefinitions",
        ":PREDICTION_DEFINITION_ID"
      ],
      "variable": [
        {
          "key": "PREDICTION_DEFINITION_ID",
          "value": ""
        }
      ]
    },
    "description": "Get available prediction definitions."
  },
  "response": [
    {
      "name": "Prediction definition metadata",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/smartdatadiscovery/predictionDefinitions/1OR5Y0000010ws8WAA",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "smartdatadiscovery",
            "predictionDefinitions",
            "1OR5Y0000010ws8WAA"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 04 Mar 2021 13:45:58 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    \"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}"
    }
  ]
}