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


Edits properties of an existing global Caslib. Session Caslib properties cannot be edited. Editable properties include the following: * description * path

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

Caslib

application/vnd.sas.cas.caslib

Server name containing the global Caslib to be edited.

serverName

The name of the global Caslib to be edited.

caslibName

Session ID. Note that editing session-based caslibs is not supported. Passing sessionId is provided to avoid creating a new CAS session, improving performance of the call.

sessionId

Indicates whether the leaf subdirectory of the path specified should be created when changing the path. If set to true, the directory will be created if it does not exist. Defaults to false.

createDirectory

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.

Edit a global Caslib

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.

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

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.

Status	Meaning	Description
200	OK	The Caslib was edited 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.
412	Precondition Failed	Precondition Failed.	Schema

Edit a global Caslib

Request Samples

Response Samples

Path Parameters

Query Parameters

Request Body

Responses

Name	Type	Required	Description
caslibName	string	true	The name of the global Caslib to be edited.
serverName	string	true	Server name containing the global Caslib to be edited.

Name	Type	Required	Description
createDirectory	string	false	Indicates whether the leaf subdirectory of the path specified should be created when changing the path. If set to true, the directory will be created if it does not exist. Defaults to false.
sessionId	string	false	Session ID. Note that editing session-based caslibs is not supported. Passing sessionId is provided to avoid creating a new CAS session, improving performance of the call.

Name	Type	Required	Description
attributes	array [Key/Value Array]	false	Contains 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.
description	string	false	Description of the caslib.
name	string	true	Name of the caslib.
metadataId	string	false	A read-only property containing the metadata ID assigned to this caslib.
path	string	false	The path of the caslib.
scope	string	false	The scope of the caslib. Valid values include session or global.
hidden	boolean	false	The hidden value of the caslib. True if this is a hidden caslib. False otherwise.
transient	boolean	false	The transient value of the caslib. True if this is a transient caslib. False otherwise.
type	string	true	Type of the Caslib. Valid values include any caslib type supported by the CAS server, such as Path, HDFS, DNFS, LASR, Teradata, Greenplum, and Oracle.
version	integer	false	The version of this object.