RestApiCategories.autoMachineLearning.desc

auto_machine_learning

2026.02

The Machine Learning Pipeline Automation (MLPA) API enables CRUD operations on automation projects, which automates VDMML project creation, pipeline building and training, and the production of champion models.

Machine Learning Pipeline Automation

2025.09

2025.11

2025.12

2026.01

2024.09

2025.03

2024.03

Viya_35

Update the permissions or details of an existing project share.

Request body for creating or updating a project share.
Note: sharedWithType accepts 'user' or 'group' (case-sensitive, lowercase or UPPERCASE only).


This object contains information about a project share, including who the project is shared with and what level of access they have.

Automation Project Share

projectId

shareId

Example response after successfully updating a project share from Read to Write access

The project share was updated successfully.

Content-Type

An entity tag that identifies the current version of the share

ETag

The date and time that the share was last modified

Last-Modified

Error when a required field shareType is missing from the request body

Error when shareType field has an invalid value

Error when a required field sharedWithType is missing from the request body

Error when sharedWithType field has an invalid value (e.g., 'admin', 'viewer')

Error when a required field sharedWith is missing from the request body

Error when a user attempts to share a project with themselves

Error

application/vnd.sas.error

Error when user does not have sufficient permissions to update the project share

Insufficient permissions to update project share

User does not have permission to update this share.

The specified project could not be found.

The specified project share could not be found.

Update a project share

This object contains a list of analytics project attributes related to Model Studio project settings.


Analytics Project Attributes

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

Analytics Report

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

A collection of optional settings to configure an automation project after Model Studio project is created based on analyticsProjectAttributes.


Automation Project Settings

Response object returned when a project share is created asynchronously.
Contains the share request details and a link to poll for the fully synchronized share.
The share ID, timestamps, and other fields will be available after the async sync completes.


Automation Project Share Create Response

Automation Project state. One of the enums [pending, preparing, waiting, ready, modeling, constructingPipeline, runningPipeline, quiescing, quiesced, completed, canceled, failed, oversampling, retraining].

Automation Project State

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

This object contains a summary of champion model.

Champion Model

This object contains the response to a champion model action.

Champion Model Action Response

Data Row

The callback schema for Data Mining GenAI jobs.

genAiCallback

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

Input Data

Job Definition

Job Definition Parameter

A link to a related operation or resource.

Link

This object contains metadata and information about an automation project.

Machine Learning Pipeline Automation Project

This object contains a list of automation project objects.

Machine Learning Pipeline Automation Project Collection

This object contains information for a pipeline template that can be used in project creation.

Machine Learning Pipeline Template

This object contains a list of machine learning pipeline templates.

Machine Learning Pipeline Template Collection

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

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

This object contains a list of project shares.

Project Share Collection

Project Share Type

A pair consisting of a string name and a string value. This is an element of `application/vnd.sas.properties`

Property

This object contains publish destination information.

Publish Destination

The collection of application/vnd.sas.analytics.report+json representations.

Report Collection

This object contains a data field name value pair for score data inputs and outputs.

Score Data Field Name/Value Pair

Score Data Input

Score Data Output

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

The type of entity the project is shared with.
- `user`: Share with an individual user
- `group`: Share with a group of users

Values must be exactly `user`, `USER`, `group`, or `GROUP` (case-sensitive, lowercase or UPPERCASE only).


Shared With Type

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

This object contains a list of supervised learning algorithms.

Supervised Learning Algorithm Collection

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

Name	Type	Required	Description
id	string	false	The unique identifier for this share
projectId	string	false	The ID of the automation project being shared
shareType	string	true	The type of access granted by the share Allowed values: readSharereadEditShare
sharedWith	string	true	The user or group identifier that the project is shared with
sharedWithType	string	true	The type of entity the project is shared with. `user`: Share with an individual user `group`: Share with a group of users Values must be exactly `user`, `USER`, `group`, or `GROUP` (case-sensitive, lowercase or UPPERCASE only). Allowed values: usergroup
createdBy	string	false	The user who created this share
creationTimeStamp	string<date-time>	false	The timestamp when this share was created
modifiedTimeStamp	string<date-time>	false	The timestamp when this share was last modified
links	array [Link]	false	The links that apply to this project share

Status	Meaning	Description
200	OK	The project share was updated successfully.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
403	Forbidden	User does not have permission to update this share.		Schema
404	Not Found	No share with the provided ID was found.		Schema

Update a project share

Request Samples

Response Samples

Path Parameters

Request Body

Responses