RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2024.03

2024.10

2024.11

2024.09

2024.08

2024.12

The Model Repository API provides support for registering, organizing, and managing models within a common model repository.

Model Repository

2023.10

2023.03

Viya_35

Sets the model role to champion for the specified project ID and model ID.

projectId

modelId

Model

The model was set as the project champion.

Location

ETag

Error

application/vnd.sas.error

If there is not a champion set for the project. The error message is "No model is currently set as the project champion." If there is invalid project ID, the error message is "The project ID is not valid."

Set a project champion model

An error thrown when a required resource does not exist.

Not Found Error

Model Project Collection

Contains information about a modeling project.

Model Project

A collection of project version representations.

Project Version Collection

A collection of model content representations.

Project File Collection

A project version contains models that were created for a specific period of time and that are associated with the same training data set.

Project Version

A project request contains information about a project.

Project Request

Project Content

Contains information about a model property.

Model Property

A collection of variable representations.

Variable Collection

Variable

Indicates the association between the target event values and a column within the specified training table.

Multivariate Target Event Values

A collection of historical action representations for a project.

Project Historical Action Collection

Contains information about the history of actions that have been performed for a project.

Historical Action

Model Content Collection

Contains information about model content.

Model Content

Model Collection

A collection of model version representations.

Model Version Collection

Contains information about a model version.

Model Version

Contains information about a model request.

Model Request

Contains information about the content that is included within a model transformation.

Model Transformation

Step Collection

Step

A collection of partition level representations.

Partition Level Collection

Contains information about a partition level.

Partition Level

Event Level Collection

Contains information about the event level.

Event Level

Contains information about the URI reference.

URI Reference

A collection of model repository representations.

Model Repository Collection

Contains information about a model repository.

Contains information about a project version.
Note: To update a project version using the PUT operation, you must include all of the properties.
You can retrieve the values by performing a GET operation for a project version (getProjectVersion).
These are the properties that are required for a PUT operation: id, projectId, name, and description.


Version Information

Contains information about an analytic store.

Analytic Store

A collection of analytic store representations.

Analytic Store Collection

User-Defined Tags Collection

Contains information about a user-defined tag.

User-Defined Tags

A collection of training health metrics for a model.

Model Health Metrics Collection

Contains model health metrics for the training data that is associated with a model.

Model Health Metrics

Contains the misclassification metrics for a model.

Misclassification Metrics

Contains a list of evaluation metrics for a model in each phase (training, validation, testing).

Collection of Model Metrics

A numeric evaluation metric that is associated with the model.

Model Numeric Metric

A categorical evaluation metric associated with the model.

Model Categorical Metric

Model Metrics

Contains generalizability metrics of a model.

Generalizability Metrics

Collection of Variable Importances

Variable Importance

The list of fairness metrics for a model.

Collection of Fairness Metrics

The fairness metrics for a particular variable level.

Fairness Metrics

Contains the lift statistics for a model.

Lift Statistics

Contains the information about a data table.

Data Table Information

The email address that is associated with the table.

Email Address

The physical address associated with the table.

Physical Address

Information privacy content that is associated with the table.

informationPrivacy

The information about the user of the table.

userInformation

A link to a related operation or resource.

Link

The list of links to top-level resources and operations available from the root of the API.

This is a base schema used to define paginated collections of resources. This base schema is extended by other schemas in APIs by adding an 'items' array property. These extensions define the application/vnd.sas.collection media type (version 2)

Status	Meaning	Description
201	Created	The model was set as the project champion.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	If there is not a champion set for the project. The error message is "No model is currently set as the project champion." If there is invalid project ID, the error message is "The project ID is not valid."		Schema

Set a project champion model

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses