2024.11

2024.10

2024.12

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

CAS Management

2024.03

2024.08

2024.09

2023.10

2023.03

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).


A sample request body to save a cas table to a source table or external file.

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

CAS Save Request

application/vnd.sas.cas.table.save.request

Server name for which the table is being accessed.

serverName

The name of the Caslib containing the table.

caslibName

tableName

Session ID (used when session-specific table is being accessed).

sessionId

Error

application/vnd.sas.error

The requested CAS server or Caslib does not exist.

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

Save a table

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 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.

Session

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

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

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

A link to a related operation or resource.

Name	Type	Required	Description
caslibName	string	false	Name of the output caslib to which the source table or external file will be written. If not specified, defaults to the caslib name containing the table to be saved.
format	string	false	Format of the output file. Valid values include sashdat, csv, parquet, sas7bdat. Defaults to sashdat.
replace	boolean	false	If true, any pre-existing table with the same name is replaced. Defaults to false.
compress	boolean	false	If true and saving to a sashdat, the saved table is compressed. Defaults to false.
tableName	string	false	Name of the output table or external file. If specified, this name is always used. The file extension will always honor the format requested (or default to sashdat). If this parameter is not specified, the name defaults to the same name as the source of the table being saved, provided it differs in case only from the name of the table being saved. If no source table name is available, then the name will be the same as the table. The following table shows sample scenarios and the value chosen by default for the tableName when this parameter is omitted. tablestatesourceformatdefault tableName MOREDATAloadedsashdatMOREDATA.sashdat MYDATAloadedMyData.sashdatMyData.sashdat MYDATAloadedMyData.sashdatcsvMyData.csv DATA2unloadeddata2.csvdata2.sashdat DATA3unloadeddata3.csvcsvdata3.csv DATA4loadedOtherData.csvDATA4.sashdat DATA5unloadedOtherData.csvcsvDATA5.csv
sourceTableName	string	false	Normally, the source table name for an unloaded table is determined automatically and this option is not required. If specified, this specific source table name is used as the source data to read for the save table operation.
parameters	object	false	A name/value pair map of additional parameters to pass when performing the save in the event that the table being saved is not already in memory as a CAS table and needs to be accessed from the source. These parameters generally are passed directly to the caslib source when accessing the data and are specific to the source type. Exceptions include the following parameters, which are passed directly to the Save operation: * importOptions * groupBy * orderBy * vars See the CAS action documentation for saveTable for details about the valid parameter values.

Status	Meaning	Description
201	Created	The table was saved successfully.
400	Bad Request	The request was invalid.	Schema
404	Not Found	The requested CAS server or Caslib 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.

Save a table

Request Samples

Response Samples

Path Parameters

Query Parameters

Request Body

Responses

Name	Type	Required	Description
caslibName	string	true	The name of the Caslib containing the table.
serverName	string	true	Server name for which the table is being accessed.
tableName	string	true	Table name being saved.