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

Updates the model variable that is associated with the specified model ID and variable ID.

Variable

The representation of a new model variable.

The entity tag obtained from the most recent `ETag` response header. Must match the current entity tag for the model variable.

If-Match

The unique identifier for the model. You must specify a valid model ID.

modelId

The unique identifier for the variable. You must specify a valid variable ID.

variableId

The request succeeded. The model variable was updated.

Etag

Error

application/vnd.sas.error

The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resource's last modified timestamp.

The request headers did not include a `If-Match` or `If-Unmodified-Since` precondition.

Update a model variable

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

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

Model

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)

Name	Type	Required	Description
modelId	string	true	The unique identifier for the model. You must specify a valid model ID.
variableId	string	true	The unique identifier for the variable. You must specify a valid variable ID.

Name	Type	Required	Description
createdBy	string	false	The user that created the variable.
modifiedBy	string	false	The user that last modified the variable.
creationTimeStamp	string<date-time>	false	The timestamp for when the variable was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
modifiedTimeStamp	string<date-time>	false	The timestamp for when the variable was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
name	string	false	The name of the variable.
description	string	false	The description of this variable.
role	string	false	The role of the variable. Valid values are: input, output, target
type	string	false	The type of variable. Valid values are: string, decimal, integer, boolean, date, datetime
level	string	false	The measurement level of the variable. Valid values are: binary, interval, nominal, ordinal
format	string	false	The format of the variable. An example is int32.
length	integer	false	The length of the variable.
version	integer	false	The variable representation version. The version is 2. Default: 2

Status	Meaning	Description
200	OK	The request succeeded. The model variable was updated.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag, or the `If-Unmodified-Since` request header did not match the resource's last modified timestamp.		Schema
428	Precondition Required	The request headers did not include a `If-Match` or `If-Unmodified-Since` precondition.		Schema

Update a model variable

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses