RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2024.10

2024.11

2024.03

2024.12

2024.09

2024.08

2023.10

The Model Management API provides basic resources for monitoring performance, comparing models, and running workflow processes.

Model Management

2023.03

Viya_35

Updates the variable with the specified name within the process associated with SAS Model Manager. Users can update only the variable with a name of modelProjectId.<br><br> <b>Authorization:</b> By default only users in the ApplicationAdministrators group have access to this endpoint. Authorization rules can be added to this endpoint for any set of users or groups to allow access to the associated information.

The details of the variable within a workflow process.

Contains information about the variable that is updated.

Update Variable

Etag

processId

variableName

Variable

Error

application/vnd.sas.error

No process exists with the specified ID or variable name.

The `If-Match` request header did not match the resource's entity tag (ETag).

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

Update variable within a process

Contains information about the performance job.

Performance Job

Contains information about the performance task.

Performance Task

Performance Task Collection

Performance Job Collection

Contains summary information about the KPIs that are apart of a performance definition.

Performance KPI Summary

Contains summary information about the time period for a performance definition.

Performance Period Summary

Contains summary information about a model that is part of a performance definition.

Performance Model Summary

Contains summary information about the execution of a performance definition.

Performance Task Execution Summary

The association type describes an object, such as a model repository project, that will be associated with a workflow process.

Association

The workflow object association type describes an association between a Workflow process, that is managed by the Workflow service, and a solution object such as a Model Repository project. The association exists so that when a workflow process executes, the Model Repository service can know that a project or model has a workflow process using it. This enables the Model Repository service to lock certain functions or update object data based on workflow changes.

Workflow Association

The workflow object process type describes a workflow process task that is associated with SAS Model Manager. The process is managed by the Workflow service, but is used in SAS Model Manager to add workflow control to a model project.

Workflow Process

The workflow object process request type describes what is required to start a workflow process.

Workflow Process Request

The workflow object task type describes a workflow user task that is associated with a model project. The task is viewable only by a user who is an actual owner or potential owner of the task. Potential and actual task owners are defined in the workflow definition for a workflow process.

Workflow Task

A workflow task prompt describes user input that is associated with a task.

Workflow Task Prompt

A name-value pair that is specified as a possible value for a prompt.

Workflow Task Prompt Value

The key performance indicator (KPI) representations.

KPI Collection

The project KPI defines the KPI key and value, and indicates whether the KPI is provided by the system o a custom KPI provided by a user.

Project KPI

Alert Rule Collection

Alert Rule

Alert Rule History Collection

Alert Rule History

Contains information about the execution status.

Execution Status

Contains information about a report request.

Report Request

Contains information about the URI reference.

URI Reference

Contains information about the variables that are updated.

Update Variables

variableCollection

Contains information about the message that is updated.

Update Message

Contains information about the model property.

Model Property

Model

Contains information about the report response.

Report Response

Contains information about the resource collection.

Resource Collection

Multi-Variate Prediction Summary Request

Multi-Variate Prediction Summary Response

Contains the metadata of the latest performance job.

Latest Performance Job

A link to a related operation or resource.

Link

A collection of performance health metrics for a model.

Performance Metrics Collection

Contains performance health metrics of a model.

Performance Health Metrics

Contains information about a publishing model request.

Publishing Model Request

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)

Base Collection

Request containing hints to generate mapped code using the Scoring Definition by Score Object.

Score Code Generation Request

Executable code generated by a score object using a score definition and input data. This represents application/vnd.sas.score.mapped.code media type (version 1).

Mapped Code

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

A collection of zero or more resource representations. Collections are often paginated and the items array contains one page of representations.

Collection

Contains information about publishing model content.

Name	Type	Required	Description
processId	string<object-id>	true	The workflow process ID.
variableName	string	true	The variable name.

Name	Type	Required	Description
version	integer	false	The variable schema version.
scope	string	false	The scope of the variable. Valid values: local, inherited]
type	string	false	The type of the variable. Valid values: string, number, dateTime, boolean
name	string	false	The variable name.
value	oneOfstringbooleannumber	false	The variable value.

Status	Meaning	Description
200	OK	The variable was updated.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	No process exists with the specified ID or variable name.	Schema
412	Precondition Failed	The `If-Match` request header did not match the resource's entity tag (ETag).	Schema
428	Precondition Required	The request headers did not include a `If-Match` or `If-Unmodified-Since` precondition.	Schema

Update variable within a process

Request Samples

Response Samples

Path Parameters

Header Parameters

Request Body

Responses