Filters
Categories

Rest APIs

SAS Viya REST APIs are designed for enterprise application developers who intend to build on the work of model builders and data scientists. With SAS REST APIs, you can create and access SAS resources using any client technology.

APIs are listed in alphabetical order. Filter the API list using the Categories menu.

APIs Image

Browse REST APIs

Annotations

The Annotations API allows users to associate annotations with resources that other decoupled API manage. An annotation augments a target resource, which is typically a column or table, with information that extends beyond its physical properties. This information might include categorization (such as email and address), role (such as categorical and primary key), or other descriptive information.

Authorization

Manages authorization rules and makes authorization decisions.

Business Rules

The Business Rules API supports the creation and management of business rules. These business rules are organized within rule sets.

CAS REST

Provides REST access to CAS and the CAS grid. Endpoints are grouped into three categories.

CAS Management

The CAS Management API enables users to manage and perform actions on common resources related to Cloud Analytic Services (CAS).

Catalog

The Catalog API allows for the discovery, creation, and integration of metadata. This allows management of information about other information.

Compute

The Compute API enables users to submit and execute SAS code using REST calls. Users can manage Compute contexts, create sessions, submit jobs, and access information about the session.

Data Mining

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

Data Quality

The Data Quality API retrieves information about locales, functions, definitions, and tokens provided by a Quality Knowledge Base (QKB).

Data Sources

The Data Sources API works in concert with the Data Tables and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Sources API enables retrieval of metadata for data sources and linking to their respective tables.

Data Tables

The Data Tables API works in concert with the Data Sources and Row Sets APIs to navigate, reference, and retrieve data in the SAS Viya ecosystem. The Data Tables API enables retrieval of metadata for data tables and their respective columns.

Decisions

The Decisions API supports the life cycle of decision data.

Decisions Runtime Builder

The Decisions Runtime Builder API provides functions that enable you to update the SAS Container Runtime binary files in a published image.

Detection

The SAS Detection API provides an entry point for customers with ION messages to apply a SAS Decisioning Architecture ecosystem decision to an incoming message and return results.

Detection Definition

Provides authoring rules functionality.

Detection Message Schema

This API provides lifecycle operations to design the layout of a user message including additional metadata to facilitate solution use cases. Additionally, this API also provides lifecycle operations to promote reusable message schema and variable set templates (aka definitions). Detection Message Schema API enables solutions to parse and validate the message schema against the actual message, detect data quality issues, enforce coherent structures of messages within an organization. In addition, it supports flexible and hierarchical layouts.

Files

The Files API provides persistence of files, such as comment attachments and report images.With this version File API will now support versioned files. A solution can maintain multiple versions of a file. There are few additional parameters which will be required while creation of File, which indicates that the File is a versioned file.

Folders

The Folders API provides an organizational structure for SAS and external content. It can also be used for favorites folders or a history of objects accessed. The resources that are stored in folders (members) use a URI to point back to those resources.

Health Clinical Acceleration

The Health Clinical Acceleration API provides the necessary endpoints for managing the clinical repository.

Insights

The Insights API provides insights into your data.

Job Definitions

The Job Definitions API enables users to manage job definitions.

Job Execution

The Job Execution API is used to execute and manage asynchronous jobs across environments.

List Data

This List Data API enables users to manage lookup lists across products and solutions.

Localization

The Localization service provides the ways to get, add or localize the message bundles. With the GET request, the Localization service returns the localized message bundle corresponding to the requested locale.

Micro Analytic Score

The Micro Analytic Score API provides stateless, memory-resident, high-performance program execution.

Machine Learning Pipeline Automation

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.

Model Management

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

Model Publish

The Model Publish API provides support for publishing objects to a predefined destination.

Model Repository

The Model Repository API provides support for registering, organizing, and managing models within a common model repository.

Reference Data

The Reference Data API supports the life cycle of reference data.

Relationships

This API is deprecated as of 2023.10 and will be removed in a future release. The Relationships API manages the storage and discovery of relationships, and the retrieval of networks of relationship data.

Report Images

This API is deprecated as of 2021.2.6 and will be removed in a future release.

Reports

You can use the Reports API to create, read, and update reports. This API enables basic tasks such as moving or renaming reports, as well as editorial tasks such as reading, writing, and updating report content.

Report Transforms

This API creates and manipulates "transforms" of SAS reports that conform to the Business Intelligence Report Definition (BIRD) specification. A transform is a wrapper for a BIRD report. When a transform is part of a request, it contains instructions and parameters to perform an editing action or structural modification to the report. When a transform is part of a response, it describes the action or modification that was performed or attempted. The response transform contains either the BIRD report directly, or it has a reference to a persistent report. All GET operations have a corresponding HEAD that is identical in all respects, except that a response body is not returned.

Row Sets

The Row Sets API provides a common way to reference rows of rectangular data that are available in the SAS ecosystem. The URLs for this API are the only canonical form of storing data references for SAS Viya.

SAS Logon

The SAS Logon API provides the standard OAuth protocol endpoints through which clients obtain access tokens to make API calls.

Score Definitions

The Score Definitions API is used for creating and maintaining score definitions.

Score Execution

The Score Execution API is used to produce a score by executing the mapped code generated by score objects using the score definition.

Subject Contacts

The Subject Contacts API records contacts to subjects and records documents that are produced when executing decisions and business rules.

Data Hub

The Data Hub API provides access to information that is managed by SAS Visual Investigator. This API facilitates describing data that resides in either internal writable databases or external customer-controlled read-only databases. Once the data definitions are provided as entity types, the data becomes accessible within SAS Visual Investigator. This API also provides mechanisms for fetching individual entity records that were defined by the entity type definitions.

Search and Discovery

The SAS Visual Investigator Search and Discovery API provides access to real-time exploration and visualization of the data in SAS Visual Investigator.

Treatment Definitions

The Treatment Definitions API is used for creating and maintaining treatment definitions and treatment definition groups.

Visual Analytics

The Visual Analytics API provides simplified ways to perform basic tasks with reports. Tasks include exporting a report as a PDF file, or as a package file, or exporting an image of a part of the report.

Real-Time Watchlist Screening

The Real-Time Watchlist Screening API supports screening party and payment information against lists of known or suspected parties that are involved in illegal activities, such as money laundering, terrorism financing, or other criminal behaviors.

Visual Investigator Workflow

The SAS Visual Investigator Workflow API enable users to execute and manage workflows created within SAS Visual Investigator. The SAS Visual Investigator workflows are based on an open-source engine that complies with the Business Process Model and Notation (BPMN) 2.0 standard. It supports industry standards for visual representation and behavior, and it provides support for established workflow patterns. SAS Visual Investigator workflows are efficient and scalable, and integrate with other standard business process implementations.