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

Contains information about the performance task.

Performance Task

The performance task definition was created.

A tag that identifies the revision of this performance task definition.

ETag

The URL of the performance task definition.

Location

Error

application/vnd.sas.error

Create a performance task definition

Contains information about the performance job.

Performance Job

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

Variable

Contains information about the variable that is updated.

Update Variable

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
assessAlert	string	false	The assessment measurements alert condition.
assessWarn	string	false	The assessment measurements warning condition.
characteristicAlert	string	false	The characteristic measurements alert condition.
characteristicWarn	string	false	The characteristic measurements warning condition.
createdBy	string	false	The user who created the task.
creationTimeStamp	string<date-time>	false	The timestamp for when the task was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
dataLibrary	string	false	The performance table library URI.
dataPrefix	string	false	The performance data table prefix.
id	string	false	The identifier for a performance task.
inputVariables	array [string]	false
maxBins	integer<int32>	false	The maximum bins number.
modelId	array [string]	false
modifiedBy	string	false	The user who most recently modified the task.
modifiedTimeStamp	string<date-time>	false	The timestamp for when the job was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.
outputVariables	array [string]	false
performanceResultSaved	boolean	false	Indicates whether the performance results are saved.
resultLibrary	string	false	The performance output table library URI.
scoreExecutionRequired	boolean	false	Indicates whether the scoring task execution is required.
stabilityAlert	string	false	The stability measurements alert condition.
stabilityWarn	string	false	The stability measurements warning condition.
includeAllData	boolean	false	Indicates whether to run a performance job against all the data tables in a library.
loadPerformanceResult	boolean	false	Indicates to load performance result data.
championMonitored	boolean	false	Indicates to monitor the project champion model.
challengerMonitored	boolean	false	Indicates to monitor challenger models.
traceOn	boolean	false	Indicates whether to turn on tracing.
version	integer	false	The version number of application/vnd.sas.models.performance.task+json.
variableBinMap	object	false	Variable bins

Status	Meaning	Description
201	Created	The performance task definition was created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema

Create a performance task definition

Request Samples

Response Samples

Request Body

Responses