RestApiCategories.modelsAndDecisions.desc

models_and_decisions

2025.11

2024.09

2025.08

2024.03

2025.09

2025.03

2025.07

2025.10

The Data Mining API provides resources for training, scoring, and comparing data mining models.

Data Mining

Viya_35

Returns the currently running job. The response object contains the representation of the job that is currently running. This endpoint has been deprecated and replaced by the GET /dataMiningProjectResources/projects/{projectId}/retrainJobs/@currentJob endpoint.

projectId

The request is redirected to a new permanent URL.

Location

Get the currently running job

Analytics Project

An analytics report consisting of rows of data and associated metadata (parameters).

Analytics Report

Contains a set of attributes in the form of a map from string names to arbitrary values. The values may be strings, numbers, booleans, arrays, objects or null.

Attributes

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

Data Row

Error

Input Data that will be scored.  This doesn't represent any top-level media type.

Input Data

Instant

Provides the base summary information of any object. This represents application/vnd.sas.job.definition media type (version 1).

Job Definition

Job Request

A link to a related operation or resource.

Link

Assigning Input Data column to a variable of the generated Mapped Code of Score Object. This doesn't represent any top-level media type.

Mapping

A request to score a data mining model against a data table.  The score output table is placed in the CAS library using the table name specified in the scoring request.

Model Score Request

Descriptor of a Score Object whose logic is used to produce a score for Input Data. This doesn't represent any top-level media type.

Object Descriptor

Output generated by score execution or analysis. This doesn't represent any top-level media type.

Output Table

Overrides the details of the existing Score definition.  This doesn't represent any top-level media type.

Override Score Definition

Metadata describing a particular variable.

Parameter

A definition containing details about Input Data, Score Object and Mapping. This represents application/vnd.sas.score.definition media type (version 1).

Score Definition

Contains details about execution results. This represents application/vnd.sas.score.execution media type (version 1).

Score Execution

Contains request details about how to generate score. This represents application/vnd.sas.score.execution.request media type (version 1).

Score Execution Request

Supervised Learning Algorithm. One of the enums [DecisionTree, Forest, GAM, GradientBoosting, NeuralNetwork, Regression, Ensemble, SVM].

Supervised Learning Algorithm

Describes the behavior of a supervised learning algorithm during pipeline generation. One of the enums [consider, exclude, forceInclude].

Supervised Learning Algorithm Behavior in Pipeline Generation

A collection of settings to configure a supervised learning algorithm. defaultBehavior field is read-only.

Supervised Learning Algorithm Settings in Pipeline Generation

Supervised Learning Algorithm Description

The media type of the project's parent container

The uri of the project's parent container

The timestamp when this resource was created.

The uri to the CAS table that contains the data

The user who holds the lock, if it has not expired. Only this user has write access to the project.

The timestamp when this resource was last modified.

The userid who last modified this resource.

Additional message to explain the project status

The project type.  Corresponds to a provider id

A map to hold provider specific project information

Last selected mode of sharing. If true, and shared is true, then project is shared in read-only mode. Ignored if not shared.

List of groups last selected for project sharing. Never cleared on unshare.

Flag indicating if project is currently being shared. If true, project is shared with selectedSharingGroups, which cannot be empty.

The version number of this representation schema.

vnd.sas.analytics.project

The map of attribute names to values.  The set of names is open, though individual services may define a closed set needed for a given resource in that service. The value of each attribute may be of types: number, string, boolean, array, or object.  Although property this is required, the mapping object can be empty, unless stated otherwise by specific documentation for resources where the application/vnd.sas.attributes type is used.

A brief description or label for the set of attributes.

Links to associated resources and operations. APIs may provide links for the link relations `self', `update` (to replace the attributes), `patch` (to update some attributes) or others.

The version number of the API representation. This is version 1.

application/vnd.sas.attributes

A space-delimited list of media types from which an `Accept` header may be constructed.

If populated indicates the number of items in the collection.

The number of items that were requested for the collection.

The zero-based index of the first item in the collection.

The version number of the collection representation. This representation is version 2.

Map of parameter name to associated value.

Messages that provide additional details about the cause of the error.

A message that describes how to resolve the error.

The version number of the error representation. This representation is version 2.

application/vnd.sas.error

Code containing inline data. Valid only if the type is Inline.

CAS Library name where CAS table is located. Valid only if the type is CASTable.

Name of the output table that will be generated when the inline code is executed. Valid only if the type is Inline.

CAS Server name where CAS table is located. Valid only if the type is CASTable.

Name of the CAS table. Valid only if the type is CASTable.

The number of seconds from the epoch of 1970-01-01T00:00:00Z.

The number of nanoseconds, later along the time-line, from the seconds field.  This is always positive, and never exceeds 999,999,999.

The ID of the user that created or submitted the job.

The timestamp for when the job was created, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.

The timestamp for when the state of the job changed to completed or failed, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.

The timestamp for when the job expires and will be deleted by the Job Execution service, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`. This is set by the service after the job has completed based on the value of the `expiresAfter` member of the job request.

The interval in seconds that the `heartbeatTimeStamp` should be updated by the provider or the job times out. The value for the `heatbeatInterval` is 0 when there is no heartbeat.

The timestamp for when the last heartbeat was received, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.

The unique identifier that is generated by the API.

The links that are associated with the job.

The ID of the user that last modified the job.

The timestamp for when the job was last modified, in the format of `YYYY-MM-DDThh:mm:ss.sssZ`.

The output results of the job execution (map of String, String).

The current state of the job. Valid values: pending, running, canceled, completed, failed, timedOut

The version number of the representation. The current version is 2.

application/vnd.sas.job.execution.job

The formatted time stamp when the job was created, in yyyy-mm-ddThh:mm:ssZ format

zero or more link objects. See the above link relations table for a description of the link types

The formatted time stamp when the job was modified, in yyyy-mm-ddThh:mm:ssZ format

input parameters to be collected when executing this job definition

zero or more name, value pairs (map<name, value>) needed to execute job definition, maximum name length = 100

type of job - this will determine which execution provider executes this job

This media type's schema version number. This representation is version 1.

application/vnd.sas.job.definition

If this is a link to a container, `itemType` is the media type or link type for the items in the container.

The relationship of the link to the resource.

The media type or link type of the items in the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type of the response body for a `PUT`, `POST`, or `PATCH` operation.

The media type or link type for the link.

Value that is assigned to Score Object's variable. If the mappingType is dataSource then this should be column name of the Input Data. If the mappingType is static then this should be a constant value. Required if the mappingType is datasource.

The name of the CAS library where the output table is to be saved.

The name of the table for storing the score output.

The version of the resource.  This is version 1.

Table name where the score execution or analysis output is saved.

Array of mappings between score object variables and input data columns.

Descriptor of a Score Object whose logic is used to produce a score for Input Data.

Code which should be executed before executing actual code.

The maximum width among this parameter's values.

The index of this parameter in the collection.

The parameter name. Should not be localized.

Indicates whether this parameter's values have already been formatted.

The data type of this parameter's values.

Keys used to associate this parameter with values in the rows of data.

The unique identifier of this analytics report.

The index in a collection of analytics reports. Useful when analytics reports are stored in an unordered collection but order is desired.

The collection of parameters, categorized by parameter name.

A revision number that is incremented on every update to the analytics report.

The type of analytics report. Informs clients how this analytics report should be rendered.

Whether or not to suppress intermediate tick marks on the X-axis.

Whether or not to suppress intermediate tick marks on the Y-axis.

application/vnd.sas.analytics.report

The values of the arguments described in the job definition.

The duration of time (in <a href="https://www.w3.org/TR/xmlschema-2/#duration" target="_blank">W3C XML duration format</a>) after the completion of the job when the job should be deleted by the Job Execution service.

The definition of the job that is to be executed.

The URI of the job definition that is to be executed.

The value of properties in the format of (map<string, string>) that contains name value pairs (map<name, value>). The maximum name value length is 100.

application/vnd.sas.job.execution.job.request

My Score Definition

The user who created the score definition.

The date and time that the score definition was created.

The system-assigned unique ID for this object

Zero or more links to related resources or operations.

Array of mappings between Score Object variables and Input Data columns.

The userId of the authenticated user who last updated the score definition.

The date and time that the score definition was last modified.

Descriptor of a Score Object whose logic is used to produce score for Input Data.

Preprocessing code that is executed before executing the Mapped Code.

A set of properties for this score definition.

application/vnd.sas.score.definition

File uri where the code used to generate score is saved.

The user who created the score execution.

The date and time that the score execution was created.

Contains error details if the execution is failed.

Set to true when there are warnings inside the log file.

File uri where the log of the score execution is saved.

The userId of the authenticated user who last updated the score execution.

The date and time that the score execution was last modified.

Details of the output generated by score execution.

Contains results for the score execution.

Contains request details about how to generate score.

application/vnd.sas.score.execution

My Score Execution Request

Hints used to execute an object for score.

Inline Job Definition which is used to score. Either this or jobDefinitionId should be used.

Job definition id which is used to score. Either this or the jobDefinition should be used.

Inline mapped code. Valid only when type is mappedCode. Either this or mappedCodeUri should be used.

Uri containing mapped code. Valid only when type is mappedCode. Either this or mappedCode should be used.

The descriptive name for the request. Which will be shown when showing executions.

Table details where the output will be generated after executing the mapped code.

Overrides the details of the existing score definition represented by scoreDefinitionId. Valid only when type is scoreDefinition.

Inline score definition. Valid only when type is scoreDefinition. Either this or scoreDefinitionId should be used

Score definition id which is used to score an object. Valid only when type is scoreDefinition. Either this or the scoreDefinition should be part of the request. Should not use both of them. Only valid when the type is scoreDefinition.

Score execution request can be either scoreDefinition or mappedCode. Default value is scoreDefinition.

application/vnd.sas.score.execution.request

SAS Developers

Scores a model using the Score Execution Service. This endpoint has been deprecated and replaced by the POST /dataMiningProjectResources/projects/{projectId}/models/{modelId}/scoreExecutions endpoint.

modelId

The location of the newly-created resource.

No project, model, or score table exists at the requested path.

Performs project retrain by passing a data table to use for retraining. If action=batch is set in the request, this API call performs all the operations required to retrain the project including running the pipelines. If not, retraining is initiated but the pipelines are not run. The response object contains the job created for performing retraining.

dataUri

action

The project retrain request has been accepted for processing, but the processing has not been completed.

Sets the retraining state for the project. The retraining state can be set as needed or completed. The response object contains the job created for performing the batch retraining.

state

Returns the champion model from the last retraining job. The response object contains the model.

Get the currently running job(Deprecated)

Request Samples

Response Samples

Path Parameters

Responses