|
REST Endpoint: GET: https://rason.net/api/model
A REST API endpoint that returns all available resource IDs and information for all models. Use a query parameter to filter for:
- specific named model only (name),
- the original posted model (origin),
- model version (version),
- model instance (instance),
- fitted models only (fitted),
- Excel models only (excel),
- RASON models only (RASON),
- named RASON models only (RASON)
- all named models (all)
Below is a brief explanation of the returned properties
-
ModelId: The unique identifier for the model
-
ModelName: The name of the model taken from the model text. When using POST rason.net/api/model/<name>
the name from the url is validated against the name in the model, if specified
-
ModelDescr: The model description taken directly from the model text
-
ModelFiles: The list of files used by the model as taken from the model text.
-
RuntimeToken: Lists any runtime token associated with this model
-
ModelType: Lists the type of model such as "origin", "version", "instance".
- ModelKind: Lists the kind of model such as "fitted", "excel" or "rason".
- “fitted” – fitted Data Science model in PMML/JSON format
- “excel” – models defined in Excel language
- “rason” – models defined in RASON language
-
IsChampion: True only if model has been marked as the “Champion” using the REST API
endpoint PATCH rason.net/api/model/{nameorid}.
-
ParentModelId: Identifies the model from which this model is derived. In the case of “Origin” models, this is always empty.
Otherwise, this property identifies the model used to create this model. For example, if a user POST’s a model and then PUT’s
another version of this model, "parentModelId" of the version will be the modelId of the originally posted model. Similar logic
holds for posting versions of version and instances of version.
-
QueryString: The query string associated with the model when it was created. In the case of unnamed models, this will change
throughout the model’s lifecycle. A user may post an unnamed model with a particular query string but then solve the model with
another. In the case of named models, this is the query string associated with the action used to create the model. A model could
be posted with one query string, have several versions with different query strings and associated instances with yet another
query string. If a particular version or instance doesn’t have a query string, it will inherit the query string of the parent.
-
ModelContainer: (Property only applies to Organization Account users) The container within the Azure Storage account where the model
is saved (POSTed). Otherwise, this property is reported as "null". For more information on Organization Accounts, see the Appendix:
Organization Accounts.
|