RASON Analytics API Help

REST Endpoint: GET: https://rason.net/api/model/{name}/champion

A REST API endpoint that retrieves a list of resource IDs for only the champion versions of the named model, marked by using PATCH rason.net/api/model/{nameorid}. If no champions exist, the most recent version of the model is returned.

If {name} is a valid model name, this endpoint returns the champion or the most recent version of a named model.
If {name}="fitted", this endpoint returns all champions or the most recent versions of all ModelKind=Fitted models on the user's account.
If {name} = "excel", this endpoint returns all champions or most recent versions of all ModelKind=Excel models on the user's account.
If {name} = "all", this endpoint returns all champions or most recent versions of all models on the user's account.

URL
- https://rason.net/api/model/{name}/champion
- https://rason.net/api/model/fitted/champion
- https://rason.net/api/model/rason/champion
- https://rason.net/api/model/excel/champion
- https://rason.net/api/model/all/champion
Method: GET
URL Params
Required: None

Optional: None
Headers:
Required: Authorization - Example: Authorization: bearer {your RASON token}

Optional: None
Data Params: None

Success Response

Code: 200 (OK)

Example Request: https://rason.net/api/model/StratifiedSampling/champion

Notice that only the champion version of the StratifiedSampling model was returned.

Example Response:

              
            [
              {
                "ModelId": "2590+StratifiedSampling+2020-01-04-06-50-23-416510",
                "ModelName": "StratifiedSampling",
                "ModelDescr": "transformation: stratified sampling",
                "ModelFiles": [
                  "hald-small-binary.txt"
                ],
                "RuntimeToken": "",
                "ModelType": 0,
                "ModelKind": "Origin",
                "IsChampion": true,
                "ParentModelId": null,
                "QueryString": "?modelID=2590%2bStratifiedSampling%2b2020-01-04-06-50-23-416510&_cb=1578120629964"
              }
            ]

Example Request: https://rason.net/api/model/fitted/champion

Notice that the first returned fitted model (fitted-myjsonsrc) has not been marked as a champion, so the most recent version has been returned. The second returned fitted model (LogisticRegressionFitted1) has been marked as the champion.

Example Response

              
[
  {
 
        "ModelId": "2590+fitted-myjsonsrc+2020-06-02-21-10-57-104562",
        "ModelName": "fitted-myjsonsrc",
        "ModelDescr": "classification-logistic-model.json",
        "ModelFiles": [],
        "RuntimeToken": "",
        "ModelType": "Origin",
        "ModelKind": "Fitted",
        "IsChampion": false,
        "ParentModelId": "2590+LogisticRegression+2020-05-29-15-56-23-566547",
        "QueryString": ""
    },
    {
        "ModelId": "2590+LogisticRegressionFitted1+2020-06-01-21-25-05-231970",
        "ModelName": "LogisticRegressionFitted1",
        "ModelDescr": "",
        "ModelFiles": [],
        "RuntimeToken": "",
        "ModelType": "Origin",
        "ModelKind": "Fitted",
        "IsChampion": true,
        "ParentModelId": null,
        "QueryString": ""
    }
]

Example Request: https://rason.net/api/model/rason/champion

Notice that out of the two RASON models on the User's account, the first one is simply the most recent version of the Sampling model and the 2nd is the actual champion version of the Logistic Regression model.

Example Response

              
[
    {
        "ModelId": "2590+Sampling+2020-05-29-16-32-56-004293",
        "ModelName": "Sampling",
        "ModelDescr": "",
        "ModelFiles": [
            {
                "fileName": "Sampling.xlsx",
                "isOnServer": true
            }
        ],
        "RuntimeToken": "",
        "ModelType": "Version",
        "ModelKind": "Rason",
        "IsChampion": false,
        "ParentModelId": null,
        "QueryString": ""
    },
    {
        "ModelId": "2590+LogisticRegression+2020-05-29-15-56-23-566547",
        "ModelName": "LogisticRegression",
        "ModelDescr": "classification: logistic regression; scoring example PMMLClass   
        ifier.json uses exported fitted model, lrModel, to score new data",
        "ModelFiles": [
            {
                "fileName": "hald-small-binary-train.txt",
                "isOnServer": true
            },
            {
                "fileName": "hald-small-binary-valid.txt",
                "isOnServer": true
            },
            {
                "fileName": "classification-logistic-model.xml",
                "isOnServer": false
            },
            {
                "fileName": "classification-logistic-model.json",
                "isOnServer": true
            }
        ],
        "RuntimeToken": "",
        "ModelType": "Version",
        "ModelKind": "Rason",
        "IsChampion": true,
        "ParentModelId": "2590+LogisticRegression+2020-05-28-21-04-19-737715",
        "QueryString": ""
     }
    ]

Example Request: https://rason.net/api/model/excel/champion

Notice that out of the two Excel models on the User's account, the first one has been marked as the champion (Blending(Opt)) and the second is simply the most recent version of the 2StageFarmer1(Stochastic) model.

Example Response

              
[
    {
        "ModelId": "2590+Blending(Opt)+2020-06-01-21-23-30-714655",
        "ModelName": "Blending(Opt)",
        "ModelDescr": "",
        "ModelFiles": [],
        "RuntimeToken": "",
        "ModelType": "Origin",
        "ModelKind": "Excel",
        "IsChampion": true,
        "ParentModelId": null,
        "QueryString": ""
    },
    {
        "ModelId": "2590+2StageFarmer1(Stochastic)+2020-05-26-21-46-10-180902",
        "ModelName": "2StageFarmer1(Stochastic)",
        "ModelDescr": "",
        "ModelFiles": [],
        "RuntimeToken": "",
        "ModelType": "Origin",
        "ModelKind": "Excel",
        "IsChampion": false,
        "ParentModelId": null,
        "QueryString": ""
    }
]

Example Request: https://rason.net/api/model/all/champion

All models on the User's account are marked as champions, except for the last model, 2StageFarmer1(Stochastic) which is the most recent version.

Example Response

              
            [
              {
                "ModelId": "2590+StratifiedSampling+2020-01-04-06-50-23-416510",
                "ModelName": "StratifiedSampling",
                "ModelDescr": "transformation: stratified sampling",
                "ModelFiles": [
                  "hald-small-binary.txt"
                ],
                "RuntimeToken": "",
                "ModelType": 0,
                "ModelKind": "Origin",
                "IsChampion": true,
                "ParentModelId": null,
                "QueryString": "?modelID=2590%2bStratifiedSampling%2b2020-01-04-06-50-23-
                416510&_cb=1578120629964"
              },
              {
                "ModelId": "2590+LogisticRegressionFitted1+2020-06-01-21-25-05-231970",
                "ModelName": "LogisticRegressionFitted1",
                "ModelDescr": "",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Fitted",
                "IsChampion": true,
                "ParentModelId": null,
                "QueryString": ""
              },
              {
                "ModelId": "2590+LogisticRegression+2020-05-29-15-56-23-566547",
                "ModelName": "LogisticRegression",
                "ModelDescr": "classification: logistic regression; scoring example PMMLClass
                ifier.json uses exported fitted model, lrModel, to score new data",
                "ModelFiles": [
                  {
                    "fileName": "hald-small-binary-train.txt",
                    "isOnServer": true
                  },
                  {
                    "fileName": "hald-small-binary-valid.txt",
                    "isOnServer": true
                  },
                  {
                    "fileName": "classification-logistic-model.xml",
                    "isOnServer": false
                  },
                  {
                    "fileName": "classification-logistic-model.json",
                    "isOnServer": true
                  }
                ],
                "RuntimeToken": "",
                "ModelType": "Version",
                "ModelKind": "Rason",
                "IsChampion": true,
                "ParentModelId": "2590+LogisticRegression+2020-05-28-21-04-19-737715",
                "QueryString": ""
              },
              {
                "ModelId": "2590+Blending(Opt)+2020-06-01-21-23-30-714655",
                "ModelName": "Blending(Opt)",
                "ModelDescr": "",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Excel",
                "IsChampion": true,
                "ParentModelId": null,
                "QueryString": ""
              },
              {
                "ModelId": "2590+2StageFarmer1(Stochastic)+2020-05-26-21-46-10-180902",
                "ModelName": "2StageFarmer1(Stochastic)",
                "ModelDescr": "",
                "ModelFiles": [],
                "RuntimeToken": "",
                "ModelType": "Origin",
                "ModelKind": "Excel",
                "IsChampion": false,
                "ParentModelId": null,
                "QueryString": ""
              }
            ]

Back to GET rason.net/api/model/{nameorid}

Continue to GET rason.net/api/model/{nameorid}/datamine

RASON Analytics API Help

Download RASON User Guide

Download RASON Reference

Introduction to RASON

About RASON Models and the RASON Server

Rason Subscriptions

Rason Web IDE

Creating and Running a Decision Flow

Defining Your Optimization Model

Defining Your Simulation Model

Performing Sensitivity Analysis

Defining Your Stochastic Optimization Model

Defining Your Data Science Model

Defining Custom Types

Defining Custom Functions

Defining Your Decision Table

Defining Contexts

Using the REST API

REST API Quick Call Endpoints

REST API Endpoints

Decision Flow REST API Endpoints

OData Endpoints

OData Service for Decision Flows

Creating Your Own Application

Using Arrays, For, Loops and Tables

Organization Accounts

REST Endpoint: GET: https://rason.net/api/model/{name}/champion