CAS Management

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

Servers

Contains operations to manage CAS servers.
get
Get a list of CAS servers
Internal-Use OnlyReturns a collection of CAS servers. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.server+json.
/servers
get
Get a CAS server
Internal-Use OnlyReturns a specific CAS server definition.
/servers/{serverName}
get
Get connection information for CAS server
Internal-Use OnlyReturns the connection information for a CAS server definition.
/servers/{serverName}/connection
get
Get metrics for the CAS server
Internal-Use OnlyReturns detailed server metrics about a specific CAS server.
/servers/{serverName}/metrics
get
Get the state of a CAS server
Internal-Use OnlyReturns the running state of a specific CAS server.
/servers/{serverName}/state
put
Change the state of a CAS server
Internal-Use OnlyRequest a change to the state of a CAS server. Call with an Accept header of application/json;text/plain to properly receive both success and error response types. After the state change is requested, the server will transition to the requested state. Check the interim server state by making a GET call on the same endpoint.
/servers/{serverName}/state
get
Get a list of data connectors for a CAS server
Internal-Use OnlyReturns a collection of data connectors for the respective CAS server. Standard paging, filtering, and sorting options are provided. The members of this collection use the application/vnd.sas.data.engine media type representation.
/servers/{serverName}/dataConnectors
get
Get a single data connector
Internal-Use OnlyReturns information about a single data connector based on its unique name.
/servers/{serverName}/dataConnectors/{dataConnectorName}
head
Check data connector availability
Internal-Use OnlyReturns the headers that the corresponding GET returns. Clients use this to determine whether the data connector exists.
/servers/{serverName}/dataConnectors/{dataConnectorName}
get
Get data connector definition
Internal-Use OnlyReturns the definition of the data connector as application or schema+json. This definition includes all available data connector options.
/servers/{serverName}/dataConnectors/{dataConnectorName}/definition
head
Check data source definition availability
Internal-Use OnlyReturns the headers that the corresponding GET returns. Clients might use this to determine whether the data source definition exists.
/servers/{serverName}/dataConnectors/{dataConnectorName}/definition

Sessions

Contains operations to create and manage CAS server sessions.
get
Get a list of sessions
Internal-Use OnlyReturns a collection of sessions available on the CAS server. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.session.summary+json. Returned sessions are consistent with the permissions of the user. Normally, only sessions owned by the authenticated user are returned. If a user has administrative privileges, and has elevated their session to use those privileges (see CAS Access Management microservice), all sessions on the server will be visible.
/servers/{serverName}/sessions
post
Create a session
Internal-Use OnlyCreates a new session and returns session information.
/servers/{serverName}/sessions
delete
End a session
Internal-Use OnlyTerminates a session. Sessions that can be terminated are consistent with the permissions of the user. Normally, only sessions owned by the authenticated user can be ended. If a user has administrative privileges, and has elevated their session to use those privileges (see CAS Access Management microservice), all sessions on the server can be ended.
/servers/{serverName}/sessions/{sessionId}
get
Get a session
Internal-Use OnlyRetrieves a single session for a CAS server.
/servers/{serverName}/sessions/{sessionId}
post
Set the transaction state of a CAS session
Internal-Use OnlySets the state of the session's transaction (valid values are start, commit, or cancel). Typical workflow would be to use this endpoint to start a transaction on the session. Next, use casAccessManagement lock transactions to lock the necessary objects. Then, modify permissions on those objects. Finally, commit or cancel the changes using this endpoint again.
/servers/{serverName}/sessions/{sessionId}
get
Get the state of a CAS session
Internal-Use OnlyReturns the running state of a specific CAS session.
/servers/{serverName}/sessions/{sessionId}/state

Caslibs

Contains operations to create and manage caslibs.
get
Get a list of caslibs
Internal-Use OnlyReturns a collection of caslibs available on the CAS server. Supports SAS standard paging query parameters, sorting, and filtering. This is a generic call for obtaining Caslib information. Since Caslib data source content varies widely depending on the attributes of a given data source, the information is returned as application/vnd.sas.cas.caslib+json, containing key/value pairs as returned from CAS. For specifics on a given Caslib data source type and its attributes, see the CAS libraries documentation. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.caslib+json.
/servers/{serverName}/caslibs
post
Create a Caslib
Internal-Use OnlyDefines a new caslib.
/servers/{serverName}/caslibs
post
Create a Caslib with advanced options
Internal-Use OnlyDefines a new Caslib using more advanced options. Note: If present, remove '#advanced' from the URL before submitting.
/servers/{serverName}/caslibs
delete
Remove a Caslib definition
Internal-Use OnlyRemoves a Caslib definition.
/servers/{serverName}/caslibs/{caslibName}
get
Get a Caslib
Internal-Use OnlyRetrieves a single Caslib.
/servers/{serverName}/caslibs/{caslibName}
patch
Edit a global Caslib
Internal-Use OnlyEdits properties of an existing global Caslib. Session Caslib properties cannot be edited. Editable properties include the following: * description * path
/servers/{serverName}/caslibs/{caslibName}

Sources

Contains operations to return information about data sources.
get
Get a list of source files or tables
Internal-Use OnlyReturns a collection of source files or tables accessible through the data source defined for the Caslib. For path-based caslibs, this list will include files in the file system. For non-path-based caslibs, such as database data sources, this list will include database tables. The list is returned without regard to the loaded or unloaded state of the source file or table. Sorting and filtering are not supported. SAS standard paging query parameters are supported. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.source.table+json.
/servers/{serverName}/caslibs/{caslibName}/sources
get
Get a source file or table
Internal-Use OnlyRetrieves information about a single source file or table.
/servers/{serverName}/caslibs/{caslibName}/sources/{sourceName}

Tables

Contains operations to create and manage tables in a caslib.
get
Get a list of tables
Internal-Use OnlyReturns a collection of tables accessible by the CAS server in the Caslib. Tables in this context refer to both loaded CAS tables as well as unloaded source tables. - For path-based caslibs, the source table shown will be the first matching .sashdat, .sas7bdat, .parquet, or .csv file found, in that order, independent of case. - For non-path-based caslibs (such as DBMS libraries), the source table used will be the first matching source table name found, independent of case. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.table+json.
/servers/{serverName}/caslibs/{caslibName}/tables
post
Upload a data file to the collection of tables
Internal-Use OnlyUploads a data file to the table collections using a multipart form-data post. Supported data files are csv, xls, xlsx/xlsm, sas7bdat and sashdat.
/servers/{serverName}/caslibs/{caslibName}/tables
post
Create a new in-memory table
Internal-Use OnlyCreates a new in-memory table from column information.
/servers/{serverName}/caslibs/{caslibName}/tables
delete
Delete a table from source
Internal-Use OnlyDeletes a table from Caslib source. Note that is not an unload. This operation physically removes the source table (if the source is writable). For path-based caslibs, this physically removes the file.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}
get
Get a table
Internal-Use OnlyRetrieves table information.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}
post
Save a table
Internal-Use OnlySaves a CAS table to a source table.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}
patch
Append a table
Internal-Use OnlyAppends content to the table from a secondary CAS table.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}
put
Change the scope of a loaded CAS table
Internal-Use OnlyChanges the scope of a loaded CAS table from session to global scope (promote). Operation valid only on a session table. Promote target is the same Caslib that contains the session table.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/scope
put
Load or unload a table
Internal-Use OnlyModifies the state of a table to loaded or unloaded. Returns loaded or unloaded to indicate the state after the operation.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/state
get
Get the summary for all numeric columns
Internal-Use OnlyReturns the summary for the numeric column values in the loaded CAS table Returns a collection of summaries for the numeric columns in a loaded CAS table. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.column.summary.statistics+json.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/summaryStatistics
get
Get the distinct count for all columns
Internal-Use OnlyReturns a collection of distinct count information for the columns in a loaded CAS table. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.column.distinct.count+json.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/distinctCounts

Columns

Contains operations to return information from columns in a table.
get
Get a list of columns in a table
Internal-Use OnlyReturns a collection of column info available for a table. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.column+json.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns
post
Create a Column
Internal-Use OnlyAdds a new column to a table. Since adding a column to a table modifies the in-memory structure of the table, the addition of a column creates a copy of the original table, introducing the new column in the copy. The original table is then removed
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns
get
Get column information
Internal-Use OnlyReturns information about a single column.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}
delete
Remove a column
Internal-Use OnlyRemoves a Column from a loaded table
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}
get
Get the distinct count for a column
Internal-Use OnlyReturns the distinct and missing counts for a single column in the loaded CAS table
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/distinctCount
get
Get distinct values for a column
Internal-Use OnlyReturns a collection of distinct values for a single column in a single loaded CAS table. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Returned values in the collection are all of the type of the column.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/distinctValues
get
Get the frequency for a column
Internal-Use OnlyReturns the frequency for a single column in the loaded CAS table.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/frequency
post
Get all frequency values for a column
Internal-Use OnlyCreates a CAS table containing the frequency for a single column in the loaded CAS table. The result is output to the new CAS table requested by the passed query parameters.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/frequency
get
Get the summary for a column
Internal-Use OnlyReturns the summary for a single numeric column in the loaded CAS table.
/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/summaryStatistics
post
Create a frequency table for a column
Internal-Use OnlyCreates a job, which gets the frequency for a single column in the loaded CAS table. The result is output to the new CAS table requested by the passed query parameters.
/jobs/servers/{serverName}/caslibs/{caslibName}/tables/{tableName}/columns/{columnName}/frequency

Loggers

Contains operations to create and manage loggers for a CAS server.
get
Get a list of loggers
Internal-Use OnlyReturns a collection of loggers on the CAS server. Supports SAS standard paging query parameters. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.server.logger.summary+json.
/servers/{serverName}/loggers
post
Add a logger
Internal-Use OnlyAdds a logger to a CAS server and returns the logger information.
/servers/{serverName}/loggers
get
Get a logger
Internal-Use OnlyRetrieves a single logger for a CAS server.
/servers/{serverName}/loggers/{loggerName}
put
Update a logger
Internal-Use OnlyUpdates a logger for a CAS server.
/servers/{serverName}/loggers/{loggerName}
delete
Remove a logger
Internal-Use OnlyRemoves a logger from a CAS server.
/servers/{serverName}/loggers/{loggerName}

Policies

Contains operations to create and manage policies on a CAS server.
get
Get a list of policies
Internal-Use OnlyReturns a collection of policies on the CAS server. Supports SAS standard paging query parameters, sorting, and filtering. Schema of items returned in the response collection is included below, and are of type application/vnd.sas.cas.server.policy.summary+json.
/servers/{serverName}/policies
post
Add a policy
Internal-Use OnlyAdds a policy to a CAS server and returns the created policy information.
/servers/{serverName}/policies
get
Get a policy
Internal-Use OnlyRetrieves a single policy for a CAS server.
/servers/{serverName}/policies/{policyName}
put
Update a policy
Internal-Use OnlyUpdates a policy for a CAS server.
/servers/{serverName}/policies/{policyName}
delete
Remove a policy
Internal-Use OnlyRemoves a policy from a CAS server.
/servers/{serverName}/policies/{policyName}