Cloud Analytic Services action and action sets

2024.10

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

CAS Management

2024.08

2024.09

2024.03

2024.07

2023.10

2023.03

2022.09

The CAS Management API provides the ability to manage and perform actions on common resources as they relate to Cloud Analytic Services (CAS).

Viya_35

The CAS Management API provides the ability to manage and perform actions on common resources as they relate to Cloud Analytic Services (CAS).


Creates a new session and returns session information.

Session

application/vnd.sas.cas.session

Server name in which the session is to be created.

serverName

Information about the created session was returned.

Error

application/vnd.sas.error

The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.

Create a session

The collection of column information for the specified table.

Session Collection

CAS Column

Inputs when creating new column in a table.


CAS Column Create Request

Column distinct count and missing count information.

CAS Column Distinct Count

CAS Column Frequency

CAS Column Frequency Value

CAS Column Summary Statistics

Inputs when loading a source table or file to a CAS table.

CAS Load Request

Inputs when saving a CAS table to a source table or external file.

CAS Save Request

Inputs when creating an empty in-memory table from column information.

CAS Table Create Request

Inputs when appending to a CAS table, including information about the source table.

CAS Append Request

CAS Server Collection

Information about the definition of a CAS server ID.

CAS Server

CAS Server Connection

CAS Server Metrics

The list of sessions for the requested CAS server.

A summary of the information about a CAS session.

Session Summary

emptyResponse

The collection of CAS source table or file information.

Source Table or File Collection

Detailed attributes of a source table or file in the data source of a caslib.

CAS Source Table or File

Table Reference

The list of caslibs for the requested CAS server and optional session.

Caslib Collection

The representation of a caslib. Note that links are returned only for GET calls.

Caslib

Caslib definition and options related to creation of the Caslib.

Caslib Create Request

An array of key/object pairs related to Caslib type-specific settings. Supports simple object types (string, boolean, integer, long) as well as nested arrays. See reference documentation for specific Caslib types to determine proper key/object pairs for defining a specific Caslib.

Key/Value Array

Attributes Nap

The CAS server and Caslib containing application data, such as map data.

Application Caslib

The default CAS server and Caslib for users.

Default Caslib

The CAS server and Caslib containing reference data.

Reference Caslib

The CAS server and Caslib used by the system for data produced during normal operation, such as audit records and monitoring data

System Caslib

The settings exposed for commons usage patterns of CAS servers.

CAS Management Service Settings

An array of tag values set on the server.

String Array

The list of tables for the requested CAS server and optional session. A table represents both the CAS table as well as information about the source file or table with which it is associated.

Tables Collection

Table Details

The collection of nodes for the specified CAS server.

Node Collection

Information about the definition of a CAS server node.

CAS Server Node

CAS Server Node Create Request

The collection of loggers for the specified CAS server.

Logger Collection

Summary information about a CAS server logger.

CAS Server Logger Summary

Detailed information about a CAS server logger.

CAS Server Logger

The collection of policies for the specified CAS server.

Policy Collection

Summary information about a CAS server policy.

CAS Server Policy Summary

Detailed information about a CAS server policy.

CAS Server Policy

Plain text response for updating a server's state.

Update Server State

Engine Collection

Engine

Engine Definition

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

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

A link to a related operation or resource.

Name	Type	Required	Description
authenticationType	string	true	The type of authentication used by the session. Valid values include OAuth, Windows, SSPI, External, PAM, Kerberos.
id	string	true	ID of the session.
locale	string	false	The locale of the session. If creating a new session, defaults to the locale of the Accept-Language header passed to the request. Sample values include en-us (US English), zh-cn (Chinese Simplified), ko-kr (Korean).
name	string	false	Name of the session. If not specified, defaults to casManagement.
nodeCount	integer	false	Number of nodes the session will use in the grid.
owner	string	true	Owner of the session.
state	string	true	Connected state of the session. Valid values include Inactive, Connected, Disconnected, Exception, Terminate, Removed.
timeOut	integer	false	Number of seconds after the last connection to the session is closed before session is terminated.

Status	Meaning	Description
201	Created	Information about the created session was returned.	Schema
400	Bad Request	The request was invalid.	Schema
404	Not Found	The requested CAS server does not exist.
409	Conflict	The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body.

Create a session

Request Samples

Response Samples

Path Parameters

Request Body

Responses